Get Process Definition Name and Version

API Type

REST

HTTP Method

GET

Description

Retrieves the process definition name and version.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetProcDefNameVersion/[processTemplateID]

Request Parameters

Name	Description
processTemplateID	Definition: The process definition ID for a released process definition. Type string Allowed Values: A valid process definition ID.

JavaScript Code Example

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

Java Code Example

public String GetProcDefNameVersion(String processTemplateID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetProcDefNameVersion/"
                       + processTemplateID;

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

KeyValue object, where Key contains process definition name and Value contains version.

JSON Response Body Example

{
  "GetProcDefNameVersionResult":{
  "Key":"ProcessMapApproval",
  "Value":"1.01"
}}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher