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

Name	Description
processDefinitionID	Definition: The unique reference ID for a process definition. Type string Allowed Values: A unique process definition reference ID.
activityDefinitionID	Definition: The reference ID for the XML that defines an activity. Type string Allowed Values: A valid activity definition ID.

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)
      });
});

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher