Set Process Definition Supplement

API Type

REST

HTTP Method

POST

Description

Sets supplement information related to process definition.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/SetProcDefSupplement/[processDefinitionID]/[activityDefinitionID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/SetProcDefSupplement/[processDefinitionID]/[activityDefinitionID]

Request Parameters

JavaScript Code Example

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

  var formDefBytes = GetFormDefinitionBytes(formDefXml); // Converts AgileForm definition 
                                                         // XML string to a byte array.

  var JSONObject = { supplementInfo: formDefBytes};

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
              SetProcDefSupplement/CFF4B6D3DBF546A2B0423AD413A94420/C769BA234EFD421B8B95A525B972E511",
    data: JSON.stringify(JSONObject)
      });
});

Java Code Example

public void SetProcDefSupplement() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        SetProcDefSupplement/CFF4B6D3DBF546A2B0423AD413A94420/
                        C769BA234EFD421B8B95A525B972E511";

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

  JSONObject postData = new JSONObject();

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

C# Code Example

public string SetProcDefSupplement()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         SetProcDefSupplement/CFF4B6D3DBF546A2B0423AD413A94420/
                         C769BA234EFD421B8B95A525B972E511";

    var formDefBytes = GetFormDefinitionBytes(formDefXml); // Converts AgileForm definition XML string to a byte array.
                                                         
    var JSONObject = "{\"supplementInfo\": \"formDefBytes\"}";

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

    return ops.POSTMethod(URI, jsonRequestData 
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher