Remove Group

API Type

REST

HTTP Method

POST

Description

Removes a group from the AgilePoint system.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/RemoveGroup/[groupName]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/RemoveGroup/[groupName]

Request Parameters

Name	Description
groupName	Definition: Specifies the name of a group. Type string Allowed Values: A valid group name.

JavaScript Code Example

$("#btnRemoveGroup").click(function () {
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/
                  RemoveGroup/testGroup"
  });
});

Java Code Example

public String RemoveGroup(String groupName) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/RemoveGroup/"
                       + groupName;

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

  JSONObject postData = new JSONObject();

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

}

C# Code Example

public string RemoveGroup()
  {
    string URL = "http://mydomain:9011/AgilePointServer/Admin/
                         RemoveGroup/ProjectLead";

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

    return ops.POSTMethod(URL);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher