Retrieve Closed/Open Tasks for an Object URI

This operation retrieves open or closed tasks for an object URI.

Request

Operation Endpoint:

 GET {workflowPath}/workflow/{tenantId}/tasks?objectURI={objectURI}&offset={offset}&max={max}

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:

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:
- 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
- taskID: task ID
- 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 (for open tasks only)
  - action: action name
  - label: display value for the action
- preferredAction: preferred possible user action on the task (for open tasks only)
  - action: action name
  - label: display value for the action
- isOpen: true/false to indicate if the task is open/closed
- validationMessage: validation message
- priority: task priority
- priorityClass: Urgent/High/Medium/Low based on the priority value
- lastActionTime: time of the last update on the task
- 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
- 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:

{
  "data": [{
    "assignee" : "user1",
    "createTime" : 1234567890,
    "createdBy":"user3",
    "dueDate" : 1234567890,
    "processInstanceComments" : [{
      "id" : "123",
      "message" : "Reassigned to user2",
      "author":"manager",
      "time" : 1234567890
    }],
    "taskId" : "8",
    "valid" : "true",
    "displayName" : "Review Entity to Delete",
    "processInstanceId" : "5",
    "processType" : "recommendForDelete",
    "processDefinitionDisplayName" : "Recommend for Delete",
    "taskType" : "reviewEntityToDelete",
    "objectURIs" : ["entities/e1"],
    "possibleActions" :[{
      "action": "Accept",
      "label": "Accept"
    },
    {
      "action": "Ignore",
      "label": "Ignore"
    }],
    "preferredAction" :{
      "action": "Accept",
      "label": "Accept"
    },
    "suspended" : false,
    "isOpen" : true,
    "priority" : 100,
    "priorityClass" : "High",
    "lastActionTime" : 1134567890,
    },
    {
    "assignee" : "user2",
    "createTime" : 1234567890,
    "createdBy":"user4",
    "dueDate" : 2345678901,
    "processInstanceComments" : [{
      "id" : "456",
      "message" : "Reassigned to user2",
      "author":"manager",
      "time" : 1324567890
    }],
    "taskId" : "5",
    "displayName" : "Review Potential Match",
    "processInstanceId" : "3",
    "processType" : "potentialMatchReview",
    "processDefinitionDisplayName" : "Potential Match Review",
    "taskType" : "reviewPotentialMatch",
    "objectURIs" : ["entities/e1","entities/e2"],
    "isOpen" : false,
    "validationMessage" : "Change request changeRequests/dcr1 doesn't exist",
    "priority" : 5,
    "priorityClass" : "Low",
    "lastActionTime" : 1214567890
  }],
  "offset": 0,
  "size": 2,
  "status":"OK"
}

Unify and manage your data

Retrieve Closed/Open Tasks for an Object URI

Footer