Rename portal folder

<< Click to Display Table of Contents >>

Current:  System Integration > WebAPI 

Rename portal folder

Previous pageReturn to chapter overviewNext page

Supported version: 8.5.1 and later

Request address

http://ip:port/bi/api?action=renamePortalFolder&token=xxxx

Request message

Request parameter

required parameter :xmlData(required)

<?xml version="1.0" encoding="UTF-8"?>

<info>

    <from>

            <path>folder1</path>

            <type>portalFolder</type>

     </from>

    <to>

            <path>folder2</path>

            <type>portalFolder</type>

   </to>

</info>

parametric description

Parameter is node information:

1) path(required):portal folder path

2) type(required):type

3) from(required):old path

4) to(required):new path

Sample

         $.post("http://" + ip + ":" + port + "/" + project + "/api?action=renamePortalFolder&token=xxxx",

           {xmlData : xml},

           function(result) {

           writeXml(result);

        });

     }

Response message

Response result

Successful operation:

<?xml version="1.0" encoding="UTF-8"?>

<results>

   <result>

       <level>1</level>

       <message>Update successfully.</message>

   </result>

</results>

Operation failure

<?xml version="1.0" encoding="UTF-8"?>

<results>

   <result>

       <level>6</level>

             <message>

                    Folder not found:folder1.

              </message>

   </result>

</results>

Result description

The response result information is xml. direct parse.

Level return type, different values represent different return status 1 indicates success, 6 indicates failure