Add New Group

API Type

REST

HTTP Method

POST

Description

Creates a group in AgilePoint NX, and sets the ResponsibleUser parameter as the group lead.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description
None Not Applicable

Request Body Properties

Name Description

Description
Function:
A description of an entity.
Type
string
Accepted Values:
A string that can contain spaces and special characters.

Enabled
Function:
Enables or disables an entity.
Type
bool
Accepted Values:
  • True - Enables the entity.
  • False - Disables the entity.

GroupName
Function:
Specifies the name of a group.
Type
string
Accepted Values:
A valid group name.

ResponsibleUser
Function:
The user name for the responsible user of this group.

The responsible user must be a registered AgilePoint user.

Type
string
Accepted Values:
A valid user name.

JavaScript Code Example

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

Java Code Example

public String AddGroup() {

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

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

  
    JSONObject postData = new JSONObject();
    postData.put("GroupName", "Managers");
    postData.put("Description", "Managers");
    postData.put("ResponsibleUser", "mydomain\\brian.lucas");
    postData.put("Enabled", "true");

    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string AddGroup()
  {
    string URL = "https://mydomain:9011/AgilePointServer/Admin/AddGroup";

    string jsonRequestData = "{
      \"GroupName\":\"" + "My sample group" + "\",
      \"Description\":\"" + "test" + "\",
      \"ResponsibleUser\":\"" + "mydomain\\\\brian.lucas" + "\",
      \"Enabled\":\"true\"}";

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password. 
curl --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"Description\":\"Adds my group\",
                         \"Enabled\":\"true\",
                         \"GroupName\":\"Managers\",
                         \"ResponsibleUser\":\"mydomain\\brian.lucas\"}
                         https://mydomain:9011/AgilePointServer/Admin/AddGroup

Output

WFGroup object represented the group that is added.

JSON Response Body Example

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

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.