Accelerate the Value of Data

Get Active Tasks

Get tasks for all tenants.

Returns tasks for all tenants with the following statuses: SCHEDULED, PROCESSING, PAUSING, PAUSED, CANCELING, WAITING_FOR_RESOURCE.

Note: Available to everyone.

Request

GET {ApplicationURL}/tasks
Table 1. Parameters
Name Required Details
max No Positive Integer value to identify the maximum number of tasks to return in a response. Default is 50.
offset No Positive Integer value to identify starting what element in the result set should be returned in a response. Can be used to organize pagination in combination with the max parameter. Default is 0.
entityTypes No .

String array to filter tasks by entityType

Example: entityTypes=ET1&entityTypes=ET2

type No

String value to filter tasks by type

Example: type=T1&type=T2

Deprecated: Use filter

createdBy No

String value to filter tasks by initiator.

Deprecated: Use filter

createdSince No

Positive Integer value to filter tasks created since this timestamp.

Deprecated: Use filter

createdBefore No

Positive Integer value to filter tasks created before this timestamp.

Deprecated: Use filter

status No

Enum value to filter tasks by status. Available values: SCHEDULED, PROCESSING, PAUSING, PAUSED, CANCELING, WAITING, WAITING_FOR_QUEUE, WAITING_FOR_RESOURCE.

Deprecated: Use filter

orderBy No Enum value to sort tasks by the field. Available values: STATUS, CREATED_BY, START_TIME, CREATED_TIME, TASK_TYPE. Default is CREATED_TIME.
ascending No Boolean value to set sort direction. Default is false.
filter No

Enables tasks filtering by a condition. Format for filter query parameter:

filter=({Condition Type}[AND/OR {Condition Type}]*)

The Condition types are:

  • equals(property, value): exact match condition ignoring case.
  • not equals(property, value): not equals condition ignoring case.
  • equalsCaseSensitive(property, value): exact match condition ignoring case.
  • containsWordStartingWith(property, tokenized value): prefix condition; returns entities that have condition property starting with condition value.
  • startsWith(property, stricted value): prefix condition; returns tasks that have condition property starting with condition value.
  • fullText(property, value): full text search; returns tasks that have condition property with condition value (any place).
  • missing(property): returns tasks with fields that have no values for property or property value is empty.
  • exists(property): returns tasks having some not empty value for property.

Search by multiple conditions is supported with AND and OR conditions.

Response

An array of active tasks.

[
   {
      "id":"d37146e6-1b55-46ef-975b-8dfd1248e46e",
      "createdTime":1440008511759,
      "createdBy":"User",
      "updatedTime":1440008514672,
      "updatedBy":"User",
      "type":"com.reltio.businesslogic.tasks.reindex.ReindexDataTask",
      "status":"PROCESSING",
      "name":"Reindexing of all types in tenant Merill (force)",
      "createdOnHost":"api01",
      "executedOnHost":"api01",
      "startTime":"08-19-2015 22.21",
      "parameters":{
         "force":"true",
         "tenantId":"Merill"
      },
      "currentState":{
         "numberOfProcessedObjects":3,
         "maxQueueSize":1,
         "entityType":"all types",
         "status":"Completed"
      },
      "throughput":0,
      "duration":"0s"
   }
]