Claims a task for a specific user.

Note: The difference with the Set Assignee method is that here a check is performed to see if the task already has a user assigned to it.

Method

POST /task/{id}/claim

Parameters

Path Parameters

Name Description
id The id of the task to claim.

Request Body

A JSON object with the following properties:

Name Description
userId The id of the user that claims the task. If userId is empty the task is unclaimed.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
500 application/json Task with given id does not exist or claiming was not successful. See the Introduction for the error response format.

Example

Request

POST /task/anId/claim

Request Body:

{"userId": "aUserId"}

Response

Status 204. No content.

On this Page: