Retrieve a List of Process Definitions

Returns process definitions.

Request

Operation Endpoint:

GET {workflowPath}/workflow/{tenantId}/processDefinitions

Table 1. Parameters
Name		Required	Details
Headers	`Authorization`	Yes	Access Token in format `"Bearer <accessToken>"` (see details in Authentication API).
Headers	`EnvironmentURL`	Yes	Reltio Environment URL.
Query	`offset`	No	Start position.
Query	`max`	No	Number of records to be returned.

Response

Response Structure:

total: total number of records
offset: start position of records
size: number of records returned
data: array with results for each element returned. Each result will have the following properties:
- id: process definition ID
- type: process definition key (provided while designing the process)
- displayName: process definition name (provided while designing the process)
- fileName: file name of the process definition
- generic: true/false (generic or tenant-specific deployment)
- deploymentId: deployment ID of the process definition
- deployTime: time of the deployment
- deployedBy: user's name who deployed
- manualStart: indicator for whether the process definition can be started from Workflow tab
- commentRequired: indicator for whether the process definition requires a comment when the process starts
error: returned if an error is encountered, contains details of the issue:
- errorCode: 5-digit error code
- errorMessage: error message
- errorData: details of the error:
  - exception: exception message
  - stack: stack trace
- innerError: details of the error from Reltio API:
  - errorMessage: Reltio API error message
  - errorCode: Reltio API error code
  - innerErrorData: Reltio API inner error data
warning: returned if the operation is completed with some minor issues
status: result of the operation; possible values are "OK" or "failed"

Sample Response JSON:

{  
   "status":"OK",
   "data":[  
      {  
         "id":"dataChangeRequestReview:244:8781476",
         "type":"dataChangeRequestReview",
         "displayName":"Data Change Request Review",
         "manualStart":false,
		"commentRequired":true,
         "deploymentId":"8781474",
         "deployTime":1512989116340,
         "deployedBy":"adminqa",
         "generic":false,
         "fileName":"DataChangeRequestReview.bpmn20.dita"
      }
   ],
   "total":1,
   "offset":0,
   "size":1
}

Note: This method will return the process definitions available for the tenant along with the default process definitions (deployed for tenant as empty string). If the process definition for a particular process type is available for a tenant, the generic process definition of that process type is not returned in the list. Deactivated process definitions (with deleted attribute in data objects section being true) are not considered at all.

Unify and manage your data

Retrieve a List of Process Definitions

Sample Response JSON:

Footer