Add Group

API Type

REST

HTTP Method

POST

Description

Adds a group to the AgilePoint system.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/AddGroup

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/AddGroup

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
Description	Definition: A free text description of an entity. Type string Allowed Values: A string that can contain spaces and special characters.
Enabled	Definition: Enables or disables an entity. Type bool Allowed Values: True - Enables the entity. False - Disables the entity.
GroupName	Definition: Specifies the name of a group. Type string Allowed Values: A valid group name.
ResponsibleUser	Definition: The user name for the responsible user of this group. The responsible user must be a registered AgilePoint user. Type string Allowed Values: A valid user name.

JavaScript Code Example

$("#btnAddGroup").click(function () {
  
  var JSONObject = { 
    GroupName: "test1234", Description: "test", 
    ResponsibleUser: "demo3\\brian.lucas", Enabled: true 
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/AddGroup",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String AddGroup(String GroupName, String Description,
  String ResponsibleUser, boolean Enabled) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/AddGroup";

  HTTPOperations ops = new HTTPOperations(domain, this.userName,
                       password, appID, locale);

  try {
    JSONObject postData = new JSONObject();
    postData.put("GroupName", GroupName);
    postData.put("Description", Description);
    postData.put("ResponsibleUser", ResponsibleUser);
    postData.put("Enabled", Enabled);

    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

Output

WFGroup object represented the group that is added.

JSON Response Body Example

{
  "CreatedBy":"demo3\\administrator",
  "CreatedDate":"\/Date(1394323861255+0000)\/",
  "Description":"test",
  "Enabled":true,
  "LastModifiedBy":null,
  "LastModifiedDate":"\/Date(-62135568000000+0000)\/",
  "Name":"test1234",
  "ResponsibleUser":"demo3\\brian.lucas",
  "Source":null
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher