Get Task Details
This operation gets task details.
Request
Operation Endpoint:
Parameter | Required | Description | |
---|---|---|---|
Headers | Authorization |
Yes | Access Token in format "Bearer <accessToken>
(see details in Authentication API. |
EnvironmentURL |
Yes | Reltio Environment URL. | |
Query | showTaskVariables |
No |
If |
showTaskLocalVariables |
No |
If |
Response
Response Structure:
assignee
: task assigneecreateTime
: task creation timecreatedBy
: task creatordueDate
: 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 IDmessage
: comment messageauthor
: comment authortime
: comment time
displayName
: task nameprocessInstanceId
: process instance IDprocessType
: process definition typeprocessDefinitionDisplayName
: process definition display nametaskType
: 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 taskaction
: action namelabel
: display value for the action
-
preferredAction
: preferred possible user action on the taskaction
: action namelabel
: display value for the action
priority
: task prioritypriorityClass
: Urgent/High/Medium/Low based on the priority value-
repeatingTask
: indicates whether the task has been repeated or not (true/false). Thetrue
value means that a task of the same task type was created earlier in the process. Default isfalse
validationMessage
: validation messagetaskLocalVariables
-task local variablestaskVariables
-task variableserror
: 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 (entity update review for Entity e1):
Sample Response JSON (potential match review for Entity e1 with e2):