Update multiple tasks by filter

Learn how this operation enables you to update multiple tasks by using a filter.

Note: The workflow tasks are connected to objects. For example, Entities or Relations. Only the tasks for which the user has READ access to these related objects will be updated using a filer.

Request

Operation Endpoint:

POST /{tenantId}/jobs/updateTasks

Table 1. Parameters
Parameter	Name		Required	Details
Headers	`Authorization`		Yes	Access Token in the format `Bearer <accessToken>` (see details in Authentication API).
	`Content-Type`		Yes	`Content-Type: application/json`.
	`EnvironmentURL`		Yes	Reltio environmental URL.
Body	`filter`		Yes	Task filter.
		`assignee`	Yes	Task assignee.
		`processInstanceId`	No	Process instance ID.
		`processType`	No	Process definition type. Use this field to filter on a single process type.
		`processTypes`	No	Process definition type. Use this field to filter on multiple process types. For example, `dataChangeRequestReview` and `recommendForDelete`.
		`suspended`	No	Boolean state of the task: possibilities are `true` or `false`.
		`createdBy`	No	Initiator of the process instance.
		`priorityClass`	No	Priority class of the tasks.
		`taskType`	No	Type of tasks.
		`createdAfter`	No	Time in milliseconds.
		`createdBefore`	No	Time in milliseconds.
		`state`	No	Validation state of the process instance (default = `valid`).
		`objectURIs`	No	List of Reltio object URIs (entity/relation) filtering by `AND-condition`.
	`changes`		Yes	List of changes.
		`objectURIs`	No	List of Reltio object URIs (entity/relation) filtering by `AND-condition`.
		`assignee`	No	Assignee of the active task.
		`dueDate`	No	Time in milliseconds.
		`processInstanceComment`	No	Comment in string format.
		`priority`	No	Task priority.
	`exclude`		No	List of tasks in string format.

Sample Request JSON:

{
   "filter":{
      "assignee":"string",
      "processInstanceId":"string",
      "processTypes":"array",
      "suspended":true,
      "createdBy":"string",
      "priorityClass":"Urgent",
      "taskType":"string",
      "createdAfter":0,
      "createdBefore":0,
      "state":"valid",
      "objectURIs":[
         "string"
      ]
   },
   "changes":{
      "objectURIs":[
         "string"
      ],
      "assignee":"string",
      "dueDate":0,
      "processInstanceComment":"string",
      "priority":0
   },
   "exclude":[
      "string"
   ]
}

Response

Response Structure:

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 the Reltio API:
  - errorMessage: Reltio API error message
  - errorCode: Reltio API error code
  - innerErrorData: Reltio API inner error data
status: Result of the operation; possible values are OK or failed

Example

POST {workflowURL}/{tenantId}/jobs/updateTasks

Sample Response JSON:

{
   "status":"OK",
   "backgroundTaskId":"2b1ac782-1459-45e0-979a-8f1fc65e50fd"
}

Accelerate the Value of Data

Update multiple tasks by filter

Footer