Add Identity Link

Adds an identity link to a task. Can be used to link any user or group to a task and specify and relation.

Method

POST /task/{id}/identity-links

Parameters

Path Parameters

Name Description
id The id of the task to add a link to.

Request Body

A JSON object with the following properties:

Name Description
userId The id of the user to link to the task. If you set this parameter, you have to omit groupId.
groupId The id of the group to link to the task. If you set this parameter, you have to omit userId.
type Sets the type of the link. Must be provided.

Result

This method returns no content.

Response Codes

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

Example

Request

POST /task/anId/identity-links

Request body:

{"groupId": "aNewGroupId", "type": "candidate"}

Response

Status 204. No content.

On this Page: