1.3 添加用户

<< Click to Display Table of Contents >>

当前位置:  系统集成 > WebAPI 

1.3 添加用户

 Previous pageReturn to chapter overviewNext page

下表中，表1为XML请求方式，表2为JSON请求方式：

请求地址

http://ip:port/bi/api?action=saveNode&type=user&token=xxxx

请求消息

请求参数

请求参数：xmlData（必填）

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

<info>

 <user>

         <name>hunk1</name>

         <pass></pass>

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

                     <alias>hunk</alias>

         <parent></parent>

         <roles></roles>

 </user>

</info>

或者

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

<info>

 <user isOverWrite="true">

         <name>hunk1</name>

         <pass></pass>

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

                    <alias>hunk</alias>

         <parent>testgroup,g1</parent>

         <roles>role1,role2</roles>

 </user>

</info>

参数描述

请求参数为用户信息：

1)name（必填）：用户名，用户名不能为特殊字符”\ /:*?"<>|;,.“。

2)pass（选填）：密码，如果不填密码即<pass></pass>，pass就是默认密码g5；如果设置密码，密码长度不能小于8，并且必须同时包含数字和非数字字符。在请求参数中密码设置特殊字符<、&时，需要用实体引用&lt;和&amp;代替。

3)email（选填）：邮箱

4)alias（选填）: 昵称

5)parent（添加根目录下的用户时不填，添加组下的用户时必填）：用户所在的文件夹（用户组），必须是系统存在的组，多个以逗号分隔。

6)roles（选填）：包含的角色，必须是系统存在的角色，多个以逗号分隔，如：role1，role2，role3。

7)当配置isOverWrite="true" 时，可以更新用户；不配置isOverWrite="true" 时，不更新用户。

示例

function addUser() {

  var xml = getXml();

    $.post("http://ip:port/bi/api?action=saveNode&type=user&token=xxxx",

    {xmlData : xml},

    function(result) {

       console.log(result);

    });

  }

响应消息

响应结果

1) 操作成功

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

<results>

  <result>

         <level>1</level>

         <message>操作成功。</message>

  </result>

</results>

2) 操作失败

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

<results>

  <result>

         <level>6</level>

         <message>Id已存在。</message>

  </result>

</results>

或者

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

<results>

  <result>

         <level>6</level>

         <message>文件夹“g3"找不到。</message>

  </result>

</results>

结果描述

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

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

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

表1

请求地址

http://ip:port/bi/api?action=saveNode&type=user&token=xxxx

请求消息

请求参数

请求参数：xmlData（必填）

{

 "info": {

   "user": {

     "name": "hunk1",

     "pass": "",

     "email": "test@qq.com",

     "alias": "hunk",

     "parent": "",

     "role": ""

   }

 }

}

或者

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

<info>

 <user isOverWrite="true">

         <name>hunk1</name>

         <pass></pass>

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

                    <alias>hunk</alias>

         <parent>testgroup,g1</parent>

         <roles>role1,role2</roles>

 </user>

</info>

参数描述

请求参数为用户信息：

1）name（必填）：用户名，用户名不能为特殊字符”\ /:*?"<>|;,“。

2）pass（选填）：密码，如果不填密码即"pass":""，pass就是默认密码g5；如果设置密码，密码长度不能小于8，并且必须同时包含数字和非数字字符。在请求参数中密码设置特殊字符"""、"\"时，字符前面需要用转义字符"\"。

3）email（选填）：邮箱

4）alias（选填）: 昵称，昵称不能为特殊字符“\ /:*?"<>|;,”。

5）parent（添加根目录下的用户时不填，添加组下的用户时必填）：用户所在的文件夹（用户组），必须是系统存在的组，多个以逗号分隔。

6）roles（选填）：包含的角色，必须是系统存在的角色，多个以逗号分隔，如：role1，role2，role3。

7）当配置isOverWrite="true" 时，可以更新用户；不配置isOverWrite="true" 时，不更新用户。

示例

function addUser() {

  var xml = getXml();

    $.post("http://ip:port/bi/api?action=saveNode&type=user&token=xxxx",

    {xmlData : xml},

    function(result) {

       console.log(result);

    });

  }

响应消息

响应结果

1) 操作成功

{

   "results": {

       "result": {

           "level": "1",

           "message": "操作成功。"

       }

   }

}

2) 操作失败

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

<results>

  <result>

         <level>6</level>

         <message>Id已存在。</message>

  </result>

</results>

或者

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

<results>

  <result>

         <level>6</level>

         <message>文件夹“g3"找不到。</message>

  </result>

</results>

结果描述

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

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

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

表2