Set Process Definition Supplement Information

API Type

REST

HTTP Method

POST

Description

Sets supplement information related to a process model (process definition).

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

Name	Description
processDefinitionID	Description: The unique reference ID for a process definition. Type string Allowed Values: A unique process definition reference ID.
activityDefinitionID	Description: 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",
    dataType: "text",
    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 
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password.

curl --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"supplementInfo\":\"formDefBytes\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         SetProcDefSupplement/{827128D244B4F4D91177617E951A326F}/
                         827128D244B4F4D91177617E9B21F523

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.