Skip to main content
GET
/
task
/
{id}
/
identity-links
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/task/{id}/identity-links \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "userId": "userId",
    "groupId": null,
    "type": "assignee"
  },
  {
    "userId": null,
    "groupId": "groupId1",
    "type": "candidate"
  },
  {
    "userId": null,
    "groupId": "groupId2",
    "type": "candidate"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

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

Query Parameters

​
type
string

Filter by the type of links to include.

Response

Request successful.

​
type
string | null
required

The type of the identity link. The value of the this property can be user-defined. The Process Engine provides three pre-defined Identity Link types:

  • candidate
  • assignee - reserved for the task assignee
  • owner - reserved for the task owner

Note: When adding or removing an Identity Link, the type property must be defined.

​
userId
string | null

The id of the user participating in this link. Either userId or groupId is set.

​
groupId
string | null

The id of the group participating in this link. Either groupId or userId is set.