Sign in
External Task

Get List (POST)

Queries for external tasks that fulfill given parameters in the form of a JSON object.

This method is slightly more powerful than the Get External Tasks method because it allows to specify a hierarchical result sorting.

post/external-task

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/external-task
  • Auth: HTTP basic

Query parameters

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Request body

externalTaskIdstring nullable

Filter by an external task's id.

externalTaskIdInstring[] nullable

Filter by the comma-separated list of external task ids.

topicNamestring nullable

Filter by an external task topic.

workerIdstring nullable

Filter by the id of the worker that the task was most recently locked by.

lockedboolean nullable

Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be true, as false matches any external task.

notLockedboolean nullable

Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be true, as false matches any external task.

withRetriesLeftboolean nullable

Only include external tasks that have a positive (> 0) number of retries (or null). Value may only be true, as false matches any external task.

noRetriesLeftboolean nullable

Only include external tasks that have 0 retries. Value may only be true, as false matches any external task.

lockExpirationAfterstring date-time nullable

Restrict to external tasks that have a lock that expires after a given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

lockExpirationBeforestring date-time nullable

Restrict to external tasks that have a lock that expires before a given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

activityIdstring nullable

Filter by the id of the activity that an external task is created for.

activityIdInstring[] nullable

Filter by the comma-separated list of ids of the activities that an external task is created for.

executionIdstring nullable

Filter by the id of the execution that an external task belongs to.

processInstanceIdstring nullable

Filter by the id of the process instance that an external task belongs to.

processInstanceIdInstring[] nullable

Filter by a comma-separated list of process instance ids that an external task may belong to.

processDefinitionIdstring nullable

Filter by the id of the process definition that an external task belongs to.

tenantIdInstring[] nullable

Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids.

activeboolean nullable

Only include active tasks. Value may only be true, as false matches any external task.

suspendedboolean nullable

Only include suspended tasks. Value may only be true, as false matches any external task.

priorityHigherThanOrEqualsinteger nullable

Only include jobs with a priority higher than or equal to the given value. Value must be a valid long value.

priorityLowerThanOrEqualsinteger nullable

Only include jobs with a priority lower than or equal to the given value. Value must be a valid long value.

processDefinitionKeystring nullable

Restrict to tasks that belong to a process definition with the given key.

processDefinitionKeyInstring[] nullable

Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list.

processDefinitionNamestring nullable

Restrict to tasks that belong to a process definition with the given name.

processDefinitionNameLikestring nullable

Restrict to tasks that have a process definition name that has the parameter value as a substring.

variableNamesIgnoreCaseboolean nullable

Match all variable names in this query case-insensitively. If set variableName and variablename are treated as equal.

variableValuesIgnoreCaseboolean nullable

Match all variable values in this query case-insensitively. If set variableValue and variablevalue are treated as equal.

Response

Request successful. The Response is a JSON array of external task objects.

activityIdstring nullable

The id of the activity that this external task belongs to.

activityInstanceIdstring nullable

The id of the activity instance that the external task belongs to.

errorMessagestring nullable

The full error message submitted with the latest reported failure executing this task; null if no failure was reported previously or if no error message was submitted

executionIdstring nullable

The id of the execution that the external task belongs to.

idstring nullable

The id of the external task.

lockExpirationTimestring date-time nullable

The date that the task's most recent lock expires or has expired.

processDefinitionIdstring nullable

The id of the process definition the external task is defined in.

processDefinitionKeystring nullable

The key of the process definition the external task is defined in.

processDefinitionVersionTagstring nullable

The version tag of the process definition the external task is defined in.

processInstanceIdstring nullable

The id of the process instance the external task belongs to.

tenantIdstring nullable

The id of the tenant the external task belongs to.

retriesinteger nullable

The number of retries the task currently has left.

suspendedboolean nullable

A flag indicating whether the external task is suspended or not.

workerIdstring nullable

The id of the worker that posesses or posessed the most recent lock.

topicNamestring nullable

The topic name of the external task.

priorityinteger nullable

The priority of the external task.

businessKeystring nullable

The business key of the process instance the external task belongs to.

createTimestring date-time nullable

The date that the task was created.

Changes

No recorded changes to this operation across all 1 revision of this API.