Search jobs

POST

/v2/jobs/search

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:8080/v2/jobs/search"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"filter\": { \"type\": \"charge-card\", \"state\": \"CREATED\" }, \"sort\": [ { \"field\": \"jobKey\", \"order\": \"DESC\" } ], \"page\": { \"limit\": 50 } }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'http://localhost:8080/v2/jobs/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"filter":{"type":"charge-card","state":"CREATED"},"sort":[{"field":"jobKey","order":"DESC"}],"page":{"limit":50}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:8080/v2/jobs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "filter": { "type": "charge-card", "state": "CREATED" }, "sort": [ { "field": "jobKey", "order": "DESC" } ], "page": { "limit": 50 } }'

Available inEmbeddedBundledCluster

AuthAuthenticated Bearer token or console session with X-CSRF-Token · requires history:read

Lists the jobs of the caller’s tenant as the history holds them. Every filter takes a plain value or an object of operators; sort by any 8.9 sort field; page with page.after or page.from. A job made activatable again (after a backoff) is CREATED; endTime is set once the job is completed, canceled or has thrown an error. priority is 0 and listenerEventType is UNSPECIFIED: jobs here carry neither.

Authorizations

Parameters

Header Parameters

x-tenant-id

string

>= 1 characters

Tenant selection. A principal bound to one tenant may omit it; if sent, it must equal that tenant (403 otherwise). A principal that may act in several tenants must send it on every request: without it the request is refused with 400, and a tenant it may not act in is refused with 403.

Request Body

application/json

object

filter

object

jobKey

Any of:

string

processInstanceKey

Any of:

string

processDefinitionKey

Any of:

string

elementInstanceKey

Any of:

string

type

Any of:

string

elementId

Any of:

string

processDefinitionId

Any of:

string

state

Any of:

string

kind

Any of:

string

listenerEventType

Any of:

string

deadline

Any of:

string

deniedReason

Any of:

string

endTime

Any of:

string

errorCode

Any of:

string

errorMessage

Any of:

string

hasFailedWithRetriesLeft

Any of:

string

isDenied

Any of:

string

priority

Any of:

string

retries

Any of:

string

worker

Any of:

string

creationTime

Any of:

string

lastUpdateTime

Any of:

string

tenantId

Any of:

string

sort

Sorted by these properties in turn; a missing value sorts last.

Array<object>

object

field

required

string

Allowed values: deadline deniedReason elementId elementInstanceKey endTime errorCode errorMessage hasFailedWithRetriesLeft isDenied jobKey kind listenerEventType priority processDefinitionId processDefinitionKey processInstanceKey retries state tenantId type worker

order

string

default: ASC

Allowed values: ASC DESC

page

limit (at most 500, default 100) with after (the endCursor of the previous page) or from (an offset). With a sort or a from, every match is sorted and paged by position, and endCursor continues that order. before is not supported.

object

limit

integer

default: 100 >= 1 <= 500

from

integer

after

The endCursor of the previous page.

string

before

Not supported. Any value is rejected with 400.

string

Example

{
  "filter": {
    "type": "charge-card",
    "state": "CREATED"
  },
  "sort": [
    {
      "field": "jobKey",
      "order": "DESC"
    }
  ],
  "page": {
    "limit": 50
  }
}

Responses

200

One page of jobs.

application/json

object

items

required

Array<object>

object

customHeaders

required

object

key

additional properties

string

deadline

required

Any of:

string
null

An RFC 3339 timestamp.

string format: date-time

deniedReason

required

Part of the wire shape. This release always sends null.

null

elementId

required

string

elementInstanceKey

required

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

endTime

required

Any of:

string
null

An RFC 3339 timestamp.

string format: date-time

errorCode

required

string | null

errorMessage

required

string | null

hasFailedWithRetriesLeft

required

boolean

isDenied

required

Part of the wire shape. This release always sends null.

null

jobKey

required

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

kind

required

string

Allowed values: BPMN_ELEMENT EXECUTION_LISTENER TASK_LISTENER AD_HOC_SUB_PROCESS

listenerEventType

required

string

Allowed values: UNSPECIFIED

priority

required

integer format: int32

processDefinitionId

required

string

processDefinitionKey

required

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

processInstanceKey

required

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

retries

required

integer format: int32

state

required

string

Allowed values: CANCELED COMPLETED CREATED ERROR_THROWN FAILED MIGRATED PRIORITY_UPDATED RETRIES_UPDATED TIMEOUT_UPDATED TIMED_OUT

tenantId

required

string

type

required

string

worker

required

The worker that last activated the job

string

rootProcessInstanceKey

required

Any of:

string
null

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

businessId

required

Part of the wire shape. This release always sends null.

null

creationTime

required

Any of:

string
null

An RFC 3339 timestamp.

string format: date-time

lastUpdateTime

required

Any of:

string
null

An RFC 3339 timestamp.

string format: date-time

page

required

totalItems counts every match of the query across all pages, and hasMoreTotalItems is always false. Every page with items carries both cursors; paging with page.after = endCursor ends with an empty page.

object

totalItems

required

integer format: int64

hasMoreTotalItems

required

boolean

startCursor

required

Opaque, base64. Set on every page with items; null only on an empty page.

string | null format: base64

endCursor

required

Opaque, base64. Set on every page with items; pass it as page.after for the next page, which is empty once every item was seen. null only on an empty page.

string | null format: base64

Example

{
  "items": [
    {
      "elementInstanceKey": "2251799813685249",
      "jobKey": "2251799813685249",
      "kind": "BPMN_ELEMENT",
      "listenerEventType": "UNSPECIFIED",
      "processDefinitionKey": "2251799813685249",
      "processInstanceKey": "2251799813685249",
      "state": "CANCELED",
      "rootProcessInstanceKey": "2251799813685249"
    }
  ]
}

400

The request is malformed, or it uses a property or filter this release does not support.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:invalid-argument",
  "title": "Bad Request",
  "status": 400,
  "detail": "entity key must be a positive int64 string",
  "instance": "/v2/process-instances/0"
}

401

No valid credential was presented.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer credential is required",
  "instance": "/v2/jobs/search"
}

Headers

WWW-Authenticate

string

Allowed value: Bearer

403

The caller lacks the required permission, a tenant named in the request is not the caller’s tenant, or a cookie write has no valid CSRF token.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The principal lacks the action this route requires",
  "instance": "/v2/jobs/search"
}

413

The body exceeds the configured request-size bound.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:payload-too-large",
  "title": "Payload Too Large",
  "status": 413,
  "detail": "The request exceeds the configured size limit",
  "instance": "/v2/jobs/search"
}

500

An internal failure. The details are never exposed.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:internal",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The request could not be completed",
  "instance": "/v2/jobs/search"
}

501

The operation is not offered in the engine’s current deployment mode.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:mode-not-supported",
  "title": "Mode Not Supported",
  "status": 501,
  "detail": "/v2/clock is not supported in bundled mode: the deterministic virtual clock and the storage-free reset exist only for the Embedded engine; Bundled and Cluster run on the system clock over durable history, which cannot be pinned, rewound or discarded",
  "instance": "/v2/clock",
  "mode": "bundled"
}

503

Backpressure, or a dependency is not ready. Retry with the same idempotency key.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The required engine service is not ready",
  "instance": "/v2/jobs/search"
}