Remove Custom Attributes

API Type

REST

HTTP Method

POST

Description

Removes multiple custom attributes from a custom ID.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/RemoveCustomAttrs/[customID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/RemoveCustomAttrs/[customID]

Request Parameters

Name	Description
customID	Definition: A work object ID specified within a process instance. Type string Allowed Values: One valid work object ID.

Request Body Properties

Name	Description
namesArray	Definition: The the names of one or more items, such as a properties or attributes. Type string Allowed Values: An array of valid names.

JavaScript Code Example

$("#btnRemoveCustomAttrs").click(function () {
  
  var JSONObject = { namesArray: "test2;ErrorMessage"};
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                RemoveCustomAttrs/864739D327144B22A48F77FAC09A24DB",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String RemoveCustomAttrs(String customID, String namesArray) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/RemoveCustomAttrs/"
                       + customID;

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("namesArray", namesArray);
    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

public string RemoveCustomAttrs()
  {
    string URL = "http://mydomain:9011/AgilePointServer/Workflow/
                         RemoveCustomAttrs/2926CD677D434679964F60C676206C14";

    string jsonRequestdata = "{
      \"namesArray\":\"" + "test2;ErrorMessage" + "\"}";

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

    return ops.POSTMethod(URL, jsonRequestdata);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher