Retrieve a List of Process Definitions
Returns process definitions.
Request
Operation Endpoint:
GET {workflowPath}/workflow/{tenantId}/processDefinitions| Name | Required | Details | |
|---|---|---|---|
| Headers | Authorization |
Yes | Access Token in format "Bearer <accessToken>"
(see details in Authentication API). |
EnvironmentURL |
Yes | Reltio Environment URL. | |
| Query | offset |
No | Start position. |
max |
No | Number of records to be returned. | |
Response
Response Structure:
total: total number of recordsoffset: start position of recordssize: number of records returneddata: array with results for each element returned. Each result will have the following properties:id: process definition IDtype: process definition key (provided while designing the process)displayName: process definition name (provided while designing the process)fileName: file name of the process definitiongeneric:true/false(generic or tenant-specific deployment)deploymentId: deployment ID of the process definitiondeployTime: time of the deploymentdeployedBy: user's name who deployedmanualStart: indicator for whether the process definition can be started from Workflow tab
error: returned if an error is encountered, contains details of the issue:errorCode: 5-digit error codeerrorMessage: error messageerrorData: details of the error:exception: exception messagestack: stack trace
innerError: details of the error from Reltio API:errorMessage: Reltio API error messageerrorCode: Reltio API error codeinnerErrorData: Reltio API inner error data
warning: returned if the operation is completed with some minor issuesstatus: 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,
"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.