Search a user task's audit log

POST

/v2/user-tasks/{userTaskKey}/audit-logs/search

curl --request POST \
  --url http://localhost:8080/v2/user-tasks/2251799813685249/audit-logs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "filter": { "operationType": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "result": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "actorId": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "actorType": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" }, "timestamp": { "$eq": "example", "$neq": "example", "$exists": true, "$in": [ "example" ], "$notIn": [ "example" ], "$like": "example", "$gt": "example", "$gte": "example", "$lt": "example", "$lte": "example" } }, "sort": [ { "field": "timestamp", "order": "ASC" } ], "page": { "limit": 100, "from": 1, "after": "example", "before": "example" } }'

• A local engine, as started by the quickstart

Available inEmbedded·Bundled·Cluster

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

Who did what to this task, read from its records: creation, assignments (ASSIGN, UNASSIGN), updates (listener corrections included), completion, cancellation and migration, each with the acting principal. A refused command or a listener denial is result: FAIL. Filter by operationType, result, actorId, actorType and timestamp; sort by timestamp (default order is record order), operationType or actorId. The full audit log, refused requests included, is GET /v1/audit-log.

Authorizations

• bearerAuth
• sessionCookie
• csrfToken

Parameters

Path Parameters

userTaskKey

required

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

string

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

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

Media typeapplication/json

object

filter

object

operationType

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

result

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

actorId

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

actorType

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

timestamp

Any of:

string

string

integer

integer

object

object

>= 1 properties

$eq

$neq

$exists

boolean

$in

array

$notIn

array

$like

string

$gt

$gte

$lt

$lte

sort

Array

object

field

required

string

order

string

Allowed values: ASC DESC

field

required

Allowed values: timestamp operationType actorId

page

Use at most one of from, after and before.

object

limit

integer

default: 100 >= 1 <= 1000

from

An offset into the sorted matches.

integer

after

The endCursor of the previous page.

string

before

The startCursor of the following page.

string

Responses

200

One page of audit entries.

Media typeapplication/json

object

items

required

Array<object>

One change of the task. The shape also carries the keys of the other entity kinds an audit entry can describe; for a task they are null.

object

auditLogKey

required

string

entityKey

required

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

string

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

entityType

required

string

Allowed value: USER_TASK

operationType

required

string

Allowed values: CREATE ASSIGN UNASSIGN UPDATE COMPLETE CANCEL MIGRATE

timestamp

required

An RFC 3339 timestamp.

string format: date-time

actorId

required

string | null

actorType

required

string

Allowed values: USER CLIENT UNKNOWN

tenantId

required

string

result

required

string

Allowed values: SUCCESS FAIL

category

required

string

Allowed value: USER_TASKS

processDefinitionId

string

processDefinitionKey

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]*$/

rootProcessInstanceKey

Any of:

string

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

string

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

null

null

elementInstanceKey

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

string

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

userTaskKey

required

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

string

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

formKey

Any of:

string

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

string

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

null

null

key

additional properties

any

page

required

totalItems counts every match; hasMoreTotalItems is always false. startCursor and endCursor locate the first and last item of this page (null for 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": [
    {
      "entityKey": "2251799813685249",
      "entityType": "USER_TASK",
      "operationType": "CREATE",
      "actorType": "USER",
      "result": "SUCCESS",
      "category": "USER_TASKS",
      "processDefinitionKey": "2251799813685249",
      "processInstanceKey": "2251799813685249",
      "rootProcessInstanceKey": "2251799813685249",
      "elementInstanceKey": "2251799813685249",
      "userTaskKey": "2251799813685249",
      "formKey": "2251799813685249"
    }
  ]
}

400

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

Media typeapplication/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.

Media typeapplication/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/user-tasks/2251799813685262/audit-logs/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.

Media typeapplication/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/user-tasks/2251799813685262/audit-logs/search"
}

404

The entity does not exist in the caller’s tenant.

Media typeapplication/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:not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource does not exist",
  "instance": "/v2/user-tasks/2251799813685262/audit-logs/search"
}

413

The body exceeds the configured request-size bound.

Media typeapplication/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/user-tasks/2251799813685262/audit-logs/search"
}

500

An internal failure. The details are never exposed.

Media typeapplication/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/user-tasks/2251799813685262/audit-logs/search"
}

501

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

Media typeapplication/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.

Media typeapplication/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/user-tasks/2251799813685262/audit-logs/search"
}