/
[POST] /candidates

[POST] /candidates

/api/bpm/tasks/{id}/candidates

Description

Sets a list of users and/or roles, both specified by their IDs, as the candidates of a running task. Current candidates of this task will be overwritten with the new ones, but users or roles will only be affected if you pass a value as the corresponding JSON object. If an empty array is sent, all candidates of this type will be removed.

Request
Method

POST

Response
Format

JSON

Minimum Version

1.0.0

Request
Example

/api/bpm/tasks/33AFD89453E248B4BC7CBF594D64BE36/candidates

{ "users": [{ "id": "274CB6C1780844BF987A121BC832AFA6" }], "roles": [{ "id": "727A6EA824B543668A4CF56B3EDD98A9" }] }

Result example

Response HTTP status codes:

  • 200 - The task was found and the list of candidates was updated.

  • 404 - The requested task was not found.

  • 500 - Server error.