Remove Custom Attribute

API Type

REST

HTTP Method

POST

Description

Removes a custom attribute from a custom ID.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/RemoveCustomAttr/[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
attributeName	Definition: The name of the process instance attribute you want. Type string Allowed Values: A valid process instance attribute.

JavaScript Code Example

$("#btnRemoveCustomAttr").click(function () {

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                RemoveCustomAttr/864739D327144B22A48F77FAC09A24DB/test1",
  });

});

Java Code Example

public String RemoveCustomAttr(String customID, String attributeName) {

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

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

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

C# Code Example

public string RemoveCustomAttr()
  {
    string URL = "http://mydomain:9011/AgilePointServer/Workflow/
                         RemoveCustomAttr/136D2E2E364F445F9E4B0A6673AF8F69/test1";

    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