Get Base Process Definition ID

API Type

REST

HTTP Method

GET

Description

Retrieves the ID for the first version of the process definition, called the base process definition. All subsequent process definition versions have the same base process definition ID. This call retrieves the base process definition ID with the specified process definition name.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

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

Java Code Example

public String GetDatabaseInformation() {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/GetDatabaseInfo";

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

string that contains the base process definition ID.

JSON Response Body Example

{
  "GetBaseProcDefIDResult":"5990FB41783F4C7F86E3452AFD62BB8E"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher