FLflowable
Jobs

List deadletter jobs

get/agent-management/deadletter-jobs

Request

Query parameters

idstring

Only return job with the given id

scopeIdstring

Only return jobs part of a scope with the given id

withoutScopeIdboolean

If true, only returns jobs without a scope id set. If false, the withoutScopeId parameter is ignored.

subScopeIdstring

Only return jobs part of a sub scope with the given id

scopeDefinitionIdstring

Only return jobs with the given scope definition id

scopeTypestring

Only return jobs with the given scope type

elementIdstring

Only return jobs with the given element id

elementNamestring

Only return jobs with the given element name

timersOnlyboolean

If true, only return jobs which are timers. If false, this parameter is ignored. Cannot be used together with 'messagesOnly'.

messagesOnlyboolean

If true, only return jobs which are messages. If false, this parameter is ignored. Cannot be used together with 'timersOnly'

withExceptionboolean

If true, only return jobs for which an exception occurred while executing it. If false, this parameter is ignored.

dueBeforestring date-time

Only return jobs which are due to be executed before the given date. Jobs without duedate are never returned using this parameter.

dueAfterstring date-time

Only return jobs which are due to be executed after the given date. Jobs without duedate are never returned using this parameter.

exceptionMessagestring

Only return jobs with the given exception message

tenantIdstring

Only return jobs with the given tenantId.

tenantIdLikestring

Only return jobs with a tenantId like the given value.

withoutTenantIdboolean

If true, only returns jobs without a tenantId set. If false, the withoutTenantId parameter is ignored.

lockedboolean

If true, only return jobs which are locked. If false, this parameter is ignored.

unlockedboolean

If true, only return jobs which are unlocked. If false, this parameter is ignored.

withoutProcessInstanceIdboolean

If true, only returns jobs without a process instance id set. If false, the withoutProcessInstanceId parameter is ignored.

sort'id' | 'dueDate' | 'executionId' | 'processInstanceId' | 'retries' | 'tenantId'

Property to sort on, to be used together with the order.

Response

Indicates the requested jobs were returned.

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "8",
      "url": "http://localhost:8182/management/jobs/8",
      "elementId": "scriptTask1",
      "elementName": "Script task",
      "handlerType": "cmmn-trigger-timer",
      "retries": 3,
      "exceptionMessage": "null",
      "dueDate": "2023-06-04T22:05:05.474+0000",
      "createTime": "2023-06-03T22:05:05.474+0000",
      "lockOwner": "node1",
      "lockExpirationTime": "2023-06-03T22:05:05.474+0000",
      "tenantId": "null"
    }
  ]
}

Changes

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