vividime Community

title: Add Group [Print this page]

---

author: vividime-Club    time: 2024-12-18 13:34
title: Add Group
I want to know the key steps to add group

---

author: vividime-Club    time: 2024-12-18 13:34

Request URL

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

Request Message

Request Parameter

Request parameter: xmlData (required)

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

<info>

<group>

        <name>testgroup</name>

        <parent>g1</parent>

        <roles>role1,role2</roles>

</group>

</info>

Request Parameter Description

The request parameters are group information:

•name (required): the name of the group, the group name cannot be a special character "\ /:*?" <>|;,." .".

•parent (optional when adding a group in the root directory, required when adding a group under a group): the parent group of the group, must be a group that exists in the system.

•roles (optional): roles to be included, must be system roles, multiple roles separated by commas.

➢For example:

role1,role2,role3

Request Example

function addGroup() {

var xml = getXml();

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

    {xmlData : xml},

    function(result) {

    writeXml(result);

});

}

Response Message

Response Result

•Operation successful

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

<results>

<result>

        <level>1</level>

        <message>Operation successful.</message>

</result>

</results>

•Operation failed

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

<results>

<result>

        <level>6</level>

        <message>Group already exists.</message>

</result>

</results>

or

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

<results>

<result>

        <level>6</level>

        <message>Folder "g3" could not be found.</message>

</result>

</results>

Result Description

Response result information is xml, can parse direcly.

•level return type, different values represent different return status, see Appendix.

•message is the result of api operation.

---

Welcome vividime Community (https://club.vividime.com/)

Powered by Discuz! X3.4