Request address

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

Request message

Request parameter

required parameter:xmlData (required)

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

<ref>

  <type>user</type>

</ref>

or

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

<ref>

  <type>group</type>

</ref>

or

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

<ref>

  <type>role</type>

</ref>

or

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

<ref>

  <type>user</type>

  <path>test1/hunk1</path>

</ref>

or

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

<ref>

  <type>group</type>

  <path>aaa/test1</path>

</ref>

or

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

<ref>

  <type>role</type>

  <path>admin_role</path>

</ref>

or

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

<ref>

  <type>user</type>

  <name>test1</name>

</ref>

or

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

<ref>

  <type>group</type>

  <name>bbb</name>

</ref>

or

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

<ref>

  <type>role</type>

  <name>admin_role</name>

</ref>

parametric description

Node parameter information:

1)type：type (required): Node type, including three types: user, group, and role.

2)path(optional): node full path

3)name(optional): node name

4)There can only be name or path. When name and path exist at the same time, the name will prevail.

5)If neither name nor path exists or is empty, all objects of that type are returned.

Sample

function getNode() {

  var xml = getXml();

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

     {xmlData : xml},

     function(result) {

     writeXml(result);

  });

}

Response message

Response result

1) Get user response:

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

<results>

 <result>

         <asset>

                 <user isOverWrite="true">

                         <name>hunk1</name>

                         <alias></alias>  

                                            <email>test@qq.com</email>

                         <parent>test1</parent>

                         <roles></roles>

                 </user>

         </asset>

 </result>

 <result>

         <asset>

                 <user isOverWrite="true">

                         <name>admin</name>

                         <alias></alias>

                         <email></email>

                         <parent>test1</parent>

                         <roles>admin_role</roles>

                 </user>

         </asset>

 </result>

</results>

or

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

<results>

  <result>

     <asset>

        <user>

           <name>admin</name>

           <email></email>

           <parent></parent>

           <roles>admin_role</roles>

        </user>

     </asset>

  </result>

</results>

2) Get group response:

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

<results>

  <result>

     <asset>

        <group>

           <name>test1</name>

           <parent>aaa</parent>

           <roles>admin_role</roles>

        </group>

     </asset>

  </result>

</results>

3) Get role response:

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

<results>

  <result>

     <asset>

        <role>

           <name>admin_role</name>

           <parent></parent>

           <roles></roles>

        </role>

     </asset>

  </result>

</results>

4) Operation failed

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

<results>

  <result>

     <level>6</level>

     <message>Role “role1” is not exist.</message>

  </result>

</results>

Result description

The response result information is xml, which can be directly parse.

1)Asset is the returned node information.

2)User, group, role: corresponding user, group, role information.

3)Level return type, different values represent different return status, see appendix.

4)Message is the interface operation result information.