Task Identity Link

Get List

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

get/task/{id}/identity-links

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/task/{id}/identity-links
  • Auth: HTTP basic

Path parameters

idstring required

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

Query parameters

typestring

Filter by the type of links to include.

Response

Request successful.

userIdstring nullable

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

groupIdstring nullable

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

typestring nullable 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.

Changes

No recorded changes to this operation across all 1 revision of this API.