Get Released Process Definitions

API Type

REST

HTTP Method

GET

Description

Retrieves the names and IDs of all released process definitions.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetReleasedProcDefs

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetReleasedProcDefs

Request Parameters

Name	Description
None	Not Applicable

JavaScript Code Example

$("#btnGetReleasedProcDefs").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/GetReleasedProcDefs",
    type: "GET"
  });

});

Java Code Example

public String GetReleasedProcessDefinitions() {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetProcDefs";

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetReleasedProcDefs()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/GetReleasedProcDefs";

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

    return ops.GetData(URI);
  }

Output

KeyValue array for pairs of process definition IDs and process definition names.

JSON Response Body Example

{
  "GetReleasedProcDefsResult": [
  {
    "Key": "6C7029387DB64567BFFA0F625D4314BE",
    "Value": "ProcessMapApproval"
  }]
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher