Update Multiple Group Tasks by Filter

This operation enables you to update multiple group of tasks by using a filter.

Request

Operation Endpoint:

PUT {workflowPath}/workflow/{tenantId}/groupTasks/_withFilter

Table 1. Parameters
Parameter	Name		Required	Details
Headers	`Authorization`		Yes	Access Token in 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`	No	Task assignee.
		`processInstanceId`	No	Process instance ID.
		`processType`	No	Process definition type.
		`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 = `all`); will return tasks with any state.
		`objectURIs`	No	List of Reltio object URIs (entity/relation). Filtering by `AND-condition`.
		`variables`	No	List of Reltio task variables. Each variable is a pair of keys and values.
		`local variables`	No	List of Reltio local task variables. Each variable is a pair of keys and values.
		`objectFilter`	No	A search filter expression that lets you retrieve only workflow tasks linked to entities that match the criteria. Note: This parameter is appended to the system-generated filters that select open workflow tasks. Only tasks associated with currently existing entities are included. For more information, see topic Filter workflow tasks using entity attributes.
	`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": "user1",
    "processInstanceId": "23726741",
    "processType": "dataChangeRequestReview",
    "suspended": true,
    "createdBy": "user2",
    "priorityClass": "Urgent",
    "taskType": "dcrReview",
    "createdAfter": 1601486621140,
    "createdBefore": 1601486621140,
    "state": "valid"
  },
  "changes": {
    "assignee": "string",
    "dueDate": 0,
    "processInstanceComment": "string",
    "priority": 1
  }
}

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 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

{workflowPath}/workflow/{tenantId}/groupTasks/_withFilter

Sample Response JSON:

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

For more information, see Retrieve Group Tasks for a User.

Unify and manage your data

Update Multiple Group Tasks by Filter

Footer