Skip to main content
POST
/
task
/
{id}
/
identity-links
Add
curl --request POST \
  --url http://{host}:{port}/{contextPath}/task/{id}/identity-links \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupId": "aNewGroupId",
  "type": "candidate"
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

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 add a link to.

Body

application/json
​
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.

Response

Request successful.