Unify and manage your data

Validate Tasks Using a Filter

This operation validates tasks in the background using a filter.

Request

Operation Endpoint:

POST {tenantId}/tasks/_validate
Table 1. Parameters
NameRequiredDetails
NameRequiredDetails
HeadersAuthorizationYesAccess Token in format "Bearer <accessToken>" (see details in Authentication API).
Content-TypeYesShould be "Content-Type: application/json".
EnvironmentURLYesReltio Environment URL.
Body objectURIsNoList of Reltio objectURIs (entity/relation).
assigneeNoTask assignee.
createdByNoTask owner.
processInstanceIDNoProcess instance ID.
processTypeNoProcess instance type.
taskTypeNoTask type.
createdBeforeNoTime in milliseconds.
createdAfterNoTime in milliseconds.
suspendedNoSuspended: true or false.
priorityClassNo
Priority class = ['Urgent', 'High', 'Medium', 'Low']stringEnum:"Urgent", "High", "Medium", "Low"
orderByNo
Sort criteria = ['createTime', 'assignee', 'dueDate', 'priority']stringEnum:"createTime", "assignee", "dueDate", "priority"
ascendingNoUsed in combination with orderBy.
offsetNoStart position.
maxNoNumber of records to be returned.
stateNoValidation state of a task; default value=valid. Possible values: valid, invalid, all.
objectFilterNo 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.
PathtenantIdYesTenant ID.

Example:

Sample Request JSON:

{
    "createdBy" : "user1",
    "processType" : "dataChangeRequestReview"
}

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
  • warning :returned if the operation is completed with some minor issues
  • status :result of the operation; possible values are "OK" or "failed"

Example:

Sample Response JSON:{ "status": "OK", "warning": "string"}