1.14 获取用户、组、角色节点信息

<< Click to Display Table of Contents >>

当前位置:  系统集成 > WebAPI 

1.14 获取用户、组、角色节点信息

Previous pageReturn to chapter overviewNext page

请求地址

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

请求消息

请求参数

请求参数:xmlData(必填)

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

<ref>

  <type>user</type>

</ref>

或者

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

<ref>

  <type>group</type>

</ref>

或者

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

<ref>

  <type>role</type>

</ref>

或者

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

<ref>

  <type>user</type>

  <path>g1/u1</path>

</ref>

或者

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

<ref>

  <type>group</type>

  <path>g1/g1-1</path>

</ref>

或者

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

<ref>

  <type>role</type>

  <path>admin_role</path>

</ref>

或者

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

<ref>

  <type>user</type>

  <name>u1</name>

</ref>

或者

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

<ref>

  <type>group</type>

  <name>g1</name>

</ref>

或者

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

<ref>

  <type>role</type>

  <name>admin_role</name>

</ref>

参数描述

节点参数信息:

1)type(必填):节点类型,包括三种:用户、组和角色。

2)path(选填):节点完整路径

3)name(选填):节点名称

4)name和path只能存在一个,当name和path同时存在时, 以name为准。

5)如果name和path都不存在或者为空,则返回该类型所有的对象。

示例

function getNode() {

  var xml = getXml();

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

     {xmlData : xml},

     function(result) {

     writeXml(result);

  });

}

响应消息

响应结果

1) 获取用户响应:

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

<results>

   <result>

       <asset>

           <user>

               <name>u1</name>

               <alias></alias>

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

               <parent>g1</parent>

               <roles>r1</roles>

               <priority>5</priority>

               <createUser>admin</createUser>

               <createTime>2020-10-23 13:46:41</createTime>

               <updateUser>admin</updateUser>

               <updateTime>2020-10-23 14:31:19</updateTime>

               <areaCode></areaCode>

               <mobileNumber></mobileNumber>

               <extendAttrs><定制属性1>1

               </定制属性1>

           </extendAttrs>

       </user>

   </asset>

</result>

</results>

2) 获取组响应:

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

<results>

   <result>

       <asset>

           <group>

               <name>g1</name>

               <parent>root</parent>

               <roles>r1</roles>

               <createUser>admin</createUser>

               <createTime>2020-10-23 14:30:58</createTime>

               <updateUser>admin</updateUser>

               <updateTime>2020-10-23 14:31:29</updateTime>

           </group>

       </asset>

   </result>

</results>

3) 获取角色响应:

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

<results>

   <result>

       <asset>

           <role>

               <name>r1</name>

               <createUser>admin</createUser>

               <createTime>2020-10-23 14:31:06</createTime>

               <updateUser>admin</updateUser>

               <updateTime>2020-10-23 14:31:06</updateTime>

           </role>

       </asset>

   </result>

</results>

4) 操作失败

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

<results>

  <result>

     <level>6</level>

     <message>角色“role1”不存在。</message>

  </result>

</results>

结果描述

响应结果信息为xml,直接parse即可。

1)asset 为返回的节点信息。

2)user,group,role:分别对应用户、组,角色信息。

3)可以返回的用户信息有:

name:用户的名称;

alisa:用户的昵称;

email:用户的邮箱;

parent:用户的分组;

roles:用户的角色;

priority:用户的优先级;

createUser:创建此用户的人;

createTime:创建时间;

updateUser:最近更新此用户的人;

updateTime:最近更新时间;

areaCode:区号;

mobileNumber:手机号;

extendAttrs:用户的定制属性;

4)可以返回的分组信息有:

name:分组的名称;

parent:分组的父级;

roles:分组的角色;

createUser:创建此分组的人;

createTime:创建时间;

updateUser:最近更新此分组的人;

updateTime:最近更新时间;

5)可以返回的角色信息有:

name:角色的名称;

createUser:创建此角色的人;

createTime:创建时间;

updateUser:最近更新此角色的人;

updateTime:最近更新时间;

6)level 返回类型,不同数值代表不同返回状态,见附录。

7)message为接口操作结果信息。