Get All Process Definitions

API Type

REST

HTTP Method

GET

Description

Retrieves all versions of all process models (process definitions).

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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 GetProcDefs() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/GetProcDefs";

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetProcDefs()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/GetProcDefs";

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

    return ops.GetData(URI);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password.
curl -H "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         https://mydomain:9011/AgilePointServer/Workflow/GetProcDefs

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": "mydomain\\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 v5.0 R2 and higher

Code Examples in the API Documentation

The AgilePoint NX API documentation is intended as a basic reference to help you understand how to make API calls. API code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.