Get Process Definitions

API Type

REST

HTTP Method

GET

Description

Retrieves all of process definition objects.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

JavaScript Code Example

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

Java Code Example

public String GetProcessDefinitions() {

  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 GetProcDefs()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/GetProcDefs";

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

    return ops.GetData(URI);
  }

Output

An array of WFBaseProcessDefinition objects.

JSON Response Body Example

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

Supported Versions

AgilePoint BPMS v5.0 R2 and higher