Get historic task details by ID
Learn how you can use the Get historic task details by ID endpoint to retrieve the details of a closed or historic workflow task by its task ID.
Use the Workflow to retrieve the details of a closed workflow task using its unique task ID.
Make sure you are assigned the ROLE_WORKFLOW role before you use this API.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request for retrieving a historic task by ID:
GET {workflowPath}/workflow/{tenantId}/tasks/history/{taskId}
Replace:
{workflowPath}with your Workflow API base path. For examplehttps://prod-workflow.reltio.com/workflow-adapter{tenantId}with your tenant ID.{taskId}with the ID of the historic task.
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <accessToken>. For more details, see Authentication API. | Yes |
| EnvironmentURL | Reltio environment URL | Yes |
Query parameters
The following query parameters can be included in the request.
| Parameter | Type | Required | Description |
|---|---|---|---|
| showTaskVariables | Boolean | No |
If set to |
| showTaskLocalVariables | Boolean | No |
If set to |
Example request
Use the following example to see how a complete request is structured with headers.
GET {workflowPath}/workflow/{tenantId}/tasks/history/23164197?showTaskVariables=true
Authorization: Bearer <access_token>
EnvironmentURL: https://dev.reltio.com
Response fields
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
| taskId | String | Unique identifier of the task. |
| assignee | String | User assigned to the task. |
| processInstanceId | String | Identifier of the associated process instance. |
| processType | String | Type of the process definition. |
| objectURIs | Array<String> | List of object URIs associated with the task. |
| createdBy | String | User who created the task. |
| priorityClass | String | Priority classification (for example, Low, Medium, High, or Urgent). |
| taskType | String | Type of the task definition defined during process design time. |
| createTime | Number | Timestamp (epoch milliseconds) when the task was created. |
| dueDate | Number | Timestamp (epoch milliseconds) representing the task due date. |
| displayName | String | Display name of the task. |
| processDefinitionDisplayName | String | Display name of the process definition. |
| priority | Number | Numeric priority value of the task. |
| repeatingTask | Boolean | Indicates whether the task is configured as a repeating task. |
| isOpen | Boolean | Indicates whether the task is still open (true) or closed (false). |
| completeTime | Number | Timestamp (epoch milliseconds) when the task was completed. |
| completedBy | String | User who completed the task. |
| valid | Boolean | Indicates whether the task is valid. |
| taskVariables | Object | Task-level variables returned when showTaskVariables=true. |
| taskLocalVariables | Object | Task local variables returned when showTaskLocalVariables=true. |
Example response
The following example shows a response returned for a closed task.
{
"assignee": "user1",
"processInstanceId": "23164186",
"processType": "dataChangeRequestReview",
"objectURIs": [
"changeRequests/AeFAoBPn",
"entities/16lJbKKs"
],
"createdBy": "user2",
"priorityClass": "Low",
"taskType": "dcrReview",
"createTime": 1606292473723,
"dueDate": 1606465273724,
"taskId": "23164197",
"displayName": "DCR Review",
"processDefinitionDisplayName": "Data Change Request Review",
"priority": 1,
"repeatingTask": false,
"isOpen": false,
"completeTime": 1607002013680,
"completedBy": "user1",
"valid": true
}