Get Task Details

This operation gets task details.

Request

Operation Endpoint:

 GET {workflowPath}/workflow/{tenantId} /tasks/{taskId}

Table 1. Parameters
Parameter		Required	Description
Headers	`Authorization`	Yes	Access Token in format `"Bearer <accessToken>` (see details in Authentication API.
Headers	`EnvironmentURL`	Yes	Reltio Environment URL.
Query	`showTaskVariables`	No	`true` or `false`. If `true`, returns the task variables if the user wants to view the details of the variables. Default is `false`.
Query	`showTaskLocalVariables`	No	`true` or `false`. If `true`, returns the task local variables if the user wants to view the details of the variables. Default is `false`.

Response

Response Structure:

assignee: task assignee
createTime: task creation time
createdBy: task creator
dueDate: due date for the process instance
processInstanceComments: comments for the process instance, array with results for each element returned. Each result will have the following properties:
- id: comment ID
- message: comment message
- author: comment author
- time: comment time
displayName: task name
processInstanceId: process instance ID
processType: process definition type
processDefinitionDisplayName: process definition display name
taskType: task definition type (provided during process design time)
suspended: is suspended (true/false)
objectURIs: object URIs for the task, the list contains two entities for potential matches or one entity/relation otherwise
possibleActions: possible user actions on the task
- action: action name
- label: display value for the action
preferredAction: preferred possible user action on the task
- action: action name
- label: display value for the action
priority: task priority
priorityClass: Urgent/High/Medium/Low based on the priority value
repeatingTask: indicates whether the task has been repeated or not (true/false). The true value means that a task of the same task type was created earlier in the process. Default is false
validationMessage: validation message
taskLocalVariables-task local variables
taskVariables-task variables
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 (entity update review for Entity e1):

{
    "assignee": "aflegler_dcr_rewiew",
    "processInstanceId": "9757822",
    "processType": "dataChangeRequestReview",
    "objectURIs": [
        "changeRequests/3FJnsSGF",
        "entities/16ihMXZT",
        "entities/xJWSm5f",
        "entities/xJWSabC"
    ],
    "suspended": false,
    "createdBy": "aflegler_dcr_ini",
    "priorityClass": "Medium",
    "taskType": "dcrInternalReview",
    "createTime": 1519803223049,
    "dueDate": 1520408023049,
    "processInstanceComments": [
        {
            "id": "9817798",
            "message": "Reassigned to user2",
            "author": "alexey.kononenko",
            "time": 1521087459507
        }
    ],
    "taskId": "9757836",
    "displayName": "Internal DS Review",
    "processDefinitionDisplayName": "Data Change Request Review",
    "possibleActions": [
        {
            "action": "Approve",
            "label": "Approve"
        },
        {
            "action": "Reject",
            "label": "Reject"
        }
    ],
    "priority": 50,
    "preferredAction": {
        "action": "Approve",
        "label": "Approve"
    },
    "repeatingTask": false,
    "validationMessage": "Change request changeRequests/3FJnsSGF doesn't exist",
    "status": "OK",
    "valid": false
}

Sample Response JSON (potential match review for Entity e1 with e2):

{
  "assignee" : "user1",
  "createTime" : 1234567890,
  "createdBy" : "user5",
  "dueDate" : 1234567890,
  "displayName" : "Review Match",
  "processInstanceId" : "1234",
  "processType" : "potentialMatchReview",
  "processDefinitionDisplayName" : "Review potential match",
  "suspended" : false,
  "priority" : 5,
  "priorityClass" : "Low",
  "taskType" : "reviewMatch",
  "valid" : "true",
  "objectURIs" : ["entities/e1", "entities/e2"],
  "possibleActions" : [{
    "action": "Merge",
    "label": "Merge
  },
  {
    "action": "Not a Match",
    "label": "Not a Match"
  }],
  "preferredAction" :{
    "action": "Merge",
    "label": "Merge"
  },
  "status":"OK"
}

Unify and manage your data

Get Task Details

Footer