Get Identity Links

Gets the identity links for a task, which are the users and groups that are in some relation to it (including assignee and owner).

Method

GET /task/{id}/identity-links

Parameters

Path Parameters

Name Description
id The id of the task to retrieve the identity links for.

Query Parameters

Name Description
type Filter by the type of links to include.

Result

A JSON object containing the a list of identity links.

Name Value Description
userId String The id of the user participating in this link.
groupId String The id of the group participating in this link. Either groupId or userId is set.
type String The type of the identity link. Can be any defined type. assignee and owner are reserved types for the task assignee and owner.

Response Codes

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

Example

Request

GET /task/anId/identityLinks

Response

[{
    "userId": "userId",
    "groupId": null,
    "type": "assignee"
},
{
    "userId": null,
    "groupId": "groupId1",
    "type": "candidate"
},
{
    "userId": null,
    "groupId": "groupId2",
    "type": "candidate"
}]

On this Page: