Return user task form
GET/user-tasks/:userTaskKey/form
Get the form of a user task.
This endpoint will only return linked forms. This endpoint does not support embedded forms.
This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. See the Camunda 8 REST API overview for further details.
Request
Path Parameters
The user task key.
Responses
- 200
- 204
- 400
- 401
- 404
- 500
The form is successfully returned.
- application/json
- Schema
- Example (from schema)
Schema
The key of the form.
The tenant ID of the form.
The BPMN ID of the form.
The schema of the form.
The version of the form.
{
"formKey": 0,
"tenantId": "string",
"bpmnId": "string",
"schema": {},
"version": 0
}
The user task was found, but no form is associated with it.
Bad request
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Unauthorized
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Not found
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Internal server error
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}