我的书签
添加书签
移除书签Structure
These documents explain all existing methods in the REST API. For each method they provide:
- An informal description
- HTTP verb and URL
- Possible query, path or message body parameters
- A detailed description of the response content
- Possible response codes
The methods as described work on the default process engine as given by the available service.
You may prepend /engine/{name} to any of the methods (unless otherwise documented) to access another engine where {name} is the name of the process engine as returned by ProcessEngine#getName(), e.g., /engine/myEngineName/task.
Error Handling
For every method this documentation gives possible HTTP status codes. The error code explanations do not cover all possible error causes that may arise when the request is served, for example, most of the requests will not work properly if there are problems with database access. Any of these undocumented errors will be translated to a HTTP 500 error.
If an already authenticated user interacts with a resource in an unauthorized way, the status code of the response will be set to 403 Forbidden. Details about the unauthorized interaction are provided in the response body.
Type
AuthorizationException
Response Body
Migration Validation Exceptions
If a migration plan from one process definition version to another is notvalid, a migration exception is thrown. It can be a migration plan validationexception where the plan itself is not valid, e.g., it contains an invalidinstruction. Or it can be a migrating process instance validation exception when amigration plan cannot be applied to a specific process instance, e.g., an activeactivity was not mapped by the migration plan.
Type
Response Body
Every validation report object contains the following properties:
Example
Migrating Process Instance Validation Exceptions
Type
MigratingProcessInstanceValidationException
Response Body
A JSON object with the following properties:
Every validation report object contains the following properties:
