Update Group

API Type

REST

HTTP Method

POST

Description

Updates information for a group.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

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

$("#btnUpdateGroup").click(function () {
  
  var JSONObject = { 
    GroupName: "test1234", Description: "test123", 
    ResponsibleUser: "DEMO3\\HR", Enabled: true 
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/UpdateGroup",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

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

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

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

  JSONObject postData = new JSONObject();
  try {
    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 "";
}

C# Code Example

public string UpdateGroup(string groupname, string data)
  {
    string URL = "http://mydomain:9011/AgilePointServer/Admin/UpdateGroup";

    string jsonRequestData = "{
      \"GroupName\":\"" + groupname + "\",
      \"Description\":\"" + "UpdateGroupTeest" + "\",
      \"ResponsibleUser\":\"" + data + "\",
      \"Enabled\":\"true\"}";

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

    return ops.POSTMethod(URL,jsonRequestData);
  }

Output

An updated WFGroup.

JSON Response Body Example

{
  "CreatedBy": "DEMO3\\administrator"
  "CreatedDate": "\/Date(928149600000)\/",
  "Description": "test123"
  "Enabled": true
  "LastModifiedBy": "DEMO3\\administrator"
  "LastModifiedDate": "\/Date(928149600000)\/",
  "Name": "test1234"
  "ResponsibleUser": "DEMO3\\HR"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher