Get Process Definition By Base Process Definition ID

API Type

REST

HTTP Method

GET

Description

Retrieves all process definitions by a specified base process definition ID.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetProcDefByBasePID/[baseprocessTemplateID]

Request Parameters

Name	Description
baseprocessTemplateID	Definition: The ID of the base process definition. Type string Allowed Values: A valid base process definition ID.

JavaScript Code Example

$("#btnGetProcDefByBasePID").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetProcDefByBasePID/519B54C80B90492AA198F861FDA32E40",
    type: "GET"
  });
  
});

Java Code Example

public String GetProcDefByBasePID(String baseprocessTemplateID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetProcDefByBasePID/"
                       + baseprocessTemplateID;

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

Array of WFBaseProcessDefinition objects.

JSON Response Body Example

{
  "GetProcDefByBasePIDResult": [{
  "ApplName": "MyApplication",
  "AssemblyName": "",
  "AuditLevel": 0,
  "BaseDefID": "5990FB41783F4C7F86E3452AFD62BB8E",
  "CheckedOutBy": "",
  "CheckedOutDate": "\/Date(928149600000+0000)\/",
  "ClassName": "",
  "CreatedBy": "demo3\\administrator",
  "CreatedDate": "\/Date(928149600000+0000)\/",
  "DefID": "24D6EDE684514E4684A6F0C1BB675566",
  "DefName": "ProcessMapApproval",
  "Description": "",
  "Diagnostic": false,
  "DocRef": "",
  "ExpectedTime": 
  {
    "BusinessTime": false,
    "Length": "1",
    "Unit": 
    {
      "Value": 2
    }
  },
  "InitiateConstraint": 2,
  "MaximumSessionAllowed": 0,
  "OnComplete": 0,
  "Owner": "administrator",
  "PreVersion": "1.21",
  "ReleaseDate": "\/Date(928149600000+0000)\/",
  "Rule": null,
  "Status": "Created",
  "SupplementInfo": "",
  "Version": "1.0"
  }
]}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher