FLflowable
Jobs

List history jobs

For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').

get/cmmn-management/history-jobs

Request

Query parameters

idstring

Only return the job with the given id

withExceptionboolean

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

exceptionMessagestring

Only return jobs with the given exception message

scopeTypestring

Only return jobs with the given scope type

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.

lockOwnerstring

If true, only return jobs which are owned by the given lockOwner.

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.

sort'id' | 'retries' | 'tenantId'

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

orderstring

The sort order, either 'asc' or 'desc'. Defaults to 'asc'.

startinteger

Index of the first row to fetch. Defaults to 0.

sizeinteger

Number of rows to fetch, starting from start. Defaults to 10.

Response

Indicates the requested jobs were returned.

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "8",
      "url": "http://localhost:8182/management/jobs/8",
      "scopeType": "cmmn",
      "retries": 3,
      "exceptionMessage": "null",
      "jobHandlerType": "async-history",
      "jobHandlerConfiguration": "myCfg",
      "advancedJobHandlerConfiguration": "myAdvancedCfg",
      "tenantId": "null",
      "customValues": "custom value",
      "createTime": "2023-06-03T22:05:05.474+0000",
      "lockOwner": "node1",
      "lockExpirationTime": "2023-06-03T22:05:05.474+0000"
    }
  ]
}

Changes

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