Get Portal & Portal Folder

<< Click to Display Table of Contents >>

Current:  System Integration > WebAPI 

Get Portal & Portal Folder

Previous pageReturn to chapter overviewNext page

Request address

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

Request message

Request parameter

required parameter : xmlData(required)

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

   <info>

     <user>admin</user>

 </info>

parametric description

Parameter is node information:

user(optional):  user is the target user you want to view.

Sample

function updatePortalTree() {

        var xml = getXml();

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

           {xmlData : xml},

           function(result) {

           writeXml(result);

        });

     }

Response message

Response result

1)Successful operation

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

<results>

    <assetref>

        <name>webapiFolder</name>

        <type>portalFolder</type>

        <path>webapiFolder</path>

    </assetref>

    <assetref>

        <name>portal1</name>

        <type>portal</type>

        <path>portal1</path>

    </assetref>

</results>

2)Operation failure

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

<results>

   <result>

      <level>6</level>

      <message>User 'u1' is not found.</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.