Get Process Definition Supplement

API Type

REST

HTTP Method

GET

Description

Retrieves all the process definition objects and activity objects.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetProcDefSupplement/[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

$.ajax({
  url: "https://mydomain:9011/AgilePointServer/Workflow/
    GetProcDefSupplement/CFF4B6D3DBF546A2B0423AD413A94420/C769BA234EFD421B8B95A525B972E511",
  type: "GET"
});

Java Code Example

public String GetProcessDefinitionSupplement(String processDefinitionID,
  String activityDefinitionID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetProcDefSupplement/"
                       + processDefinitionID + "/" + activityDefinitionID;

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetProcDefSupplement()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetProcDefSupplement/6E1259372F89448CA220718128ECB018/C769B";

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

    return ops.GetData(URI);
  }

Output

A byte of array represented as base64 encoded string.

JSON Response Body Example

{
  "GetProcDefSupplementResult":[
  60,
  65,
  99,	
  111,
  114,
  109,
  62
  ]
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher