Get Released Process Definition ID

API Type

REST

HTTP Method

GET

Description

Retrieves the released process definition ID by a specified process definition name.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetReleasedPID/[procDefName]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetReleasedPID/[procDefName]

Request Parameters

Name	Description
procDefName	Definition: The name of the process definition. Type string Allowed Values: A single line of text.

JavaScript Code Example

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

Java Code Example

public String GetReleasedProcessDefinitionID(String procDefName) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetReleasedPID/"
                       + procDefName;

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

The ID for the released process definition.

JSON Response Body Example

{
  "GetReleasedPIDResult":"6C7029387DB64567BFFA0F625D4314BE"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher