Get user task

GET 
/user-tasks/:userTaskKey

Get the user task by the user task key.

Request

Path Parameters

userTaskKey int64required

The user task key.

Responses

200

The user task is successfully returned.

application/json

Schema

Schema

userTaskKey int64

The key of the user task.

name string

The name for this user task.

state string

Possible values: [CREATED, COMPLETED, CANCELED, FAILED]

The state of the user task.

assignee string

The assignee of the user task.

elementId string

The element ID of the user task.

elementInstanceKey int64

The key of the element instance.

candidateGroups string[]

The candidate groups for this user task.

candidateUsers string[]

The candidate users for this user task.

processDefinitionId string

The ID of the process definition.

processDefinitionKey int64

The key of the process definition.

processInstanceKey int64

The key of the process instance.

formKey int64

The key of the form.

creationDate date-time

The creation date of a user task.

completionDate date-time

The completion date of a user task.

followUpDate date-time

The follow date of a user task.

dueDate date-time

The due date of a user task.

tenantId string

Tenant ID of this user task.

externalFormReference string

The external form reference.

processDefinitionVersion int32

The version of the process definition.

customHeaders object
Custom headers for the user task.
property name* string
priority integer

Possible values: <= 100

Default value: 50

The priority of a user task. The higher the value the higher the priority.

Example (from schema)

{
  "userTaskKey": 0,
  "name": "string",
  "state": "CREATED",
  "assignee": "string",
  "elementId": "string",
  "elementInstanceKey": 0,
  "candidateGroups": [
    "string"
  ],
  "candidateUsers": [
    "string"
  ],
  "processDefinitionId": "string",
  "processDefinitionKey": 0,
  "processInstanceKey": 0,
  "formKey": 0,
  "creationDate": "2024-12-13T13:19:42.510Z",
  "completionDate": "2024-12-13T13:19:42.510Z",
  "followUpDate": "2024-12-13T13:19:42.510Z",
  "dueDate": "2024-12-13T13:19:42.510Z",
  "tenantId": "string",
  "externalFormReference": "string",
  "processDefinitionVersion": 0,
  "customHeaders": {},
  "priority": 50
}

400

The provided data is not valid. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

The request lacks valid authentication credentials.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

Forbidden. The request is not allowed.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

The user task with the given key was not found.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...