Get a user task

GET

/v2/user-tasks/{userTaskKey}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:8080/v2/user-tasks/2251799813685249"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'http://localhost:8080/v2/user-tasks/2251799813685249';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url http://localhost:8080/v2/user-tasks/2251799813685249 \
  --header 'Authorization: Bearer <token>'

Available inEmbeddedBundledCluster

AuthAuthenticated Bearer token or console session · requires task:read

Reads one user task. A task the principal may not see answers 404, exactly like a missing one.

Authorizations

bearerAuth
sessionCookie

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.

Responses

200

The user task.

application/json

object

name

required

The name of the task’s BPMN element.

string | null

state

required

string

Allowed values: CREATED COMPLETED CANCELED

assignee

required

string | null

elementId

required

string

candidateGroups

required

Array<string>

candidateUsers

required

Array<string>

processDefinitionId

required

string

creationDate

required

An RFC 3339 timestamp.

string format: date-time

completionDate

required

Any of:

string
null

An RFC 3339 timestamp.

string format: date-time

followUpDate

required

Any of:

string
null

An RFC 3339 timestamp.

string format: date-time

dueDate

required

Any of:

string
null

An RFC 3339 timestamp.

string format: date-time

tenantId

required

string

externalFormReference

required

The form reference an application resolves itself.

string | null

processDefinitionVersion

required

integer format: int32

customHeaders

required

The task headers of the model, as text.

object

key

additional properties

string

priority

required

0 to 100, higher is more important. The model sets it with the priorityDefinition extension element (a literal or an expression); 50 when the model sets none. An update or a task listener correction may change it.

integer

<= 100

userTaskKey

required

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

string

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

elementInstanceKey

required

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

string

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

processName

required

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

null

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

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

formKey

required

Any of:

string
null

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

string

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

tags

required

Part of the wire shape. This release always sends an empty array.

Array<string>

Example

{
  "state": "CREATED",
  "userTaskKey": "2251799813685249",
  "elementInstanceKey": "2251799813685249",
  "processDefinitionKey": "2251799813685249",
  "processInstanceKey": "2251799813685249",
  "rootProcessInstanceKey": "2251799813685249",
  "formKey": "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/user-tasks/2251799813685262"
}

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/user-tasks/2251799813685262"
}

404

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

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

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/user-tasks/2251799813685262"
}

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/user-tasks/2251799813685262"
}