Skip to main content
GET
/
history
/
identity-link-log
Get Identity Link Logs
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/identity-link-log \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "1",
    "time": "2014-03-01T08:00:00.000+0200",
    "type": "candidate",
    "userId": "aUserId",
    "groupId": "aGroupId",
    "taskId": "aTaskId",
    "processDefinitionId": "12",
    "operationType": "add",
    "assignerId": "aAssignerId",
    "processDefinitionKey": "oneTaskProcess",
    "tenantId": "tenant1",
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  },
  {
    "id": "2",
    "time": "2014-03-05T10:00:00.000+0200",
    "type": "candidate",
    "userId": "aUserId",
    "groupId": "aGroupId",
    "taskId": "aTaskId",
    "processDefinitionId": "12",
    "operationType": "delete",
    "assignerId": "aAssignerId",
    "processDefinitionKey": "oneTaskProcess",
    "tenantId": "tenant1",
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
type
string

Restricts to identity links that have the given type (candidate/assignee/owner).

​
userId
string

Restricts to identity links that have the given user id.

​
groupId
string

Restricts to identity links that have the given group id.

​
dateBefore
string<date-time>

Restricts to identity links that have the time before the given time.

​
dateAfter
string<date-time>

Restricts to identity links that have the time after the given time.

​
taskId
string

Restricts to identity links that have the given task id.

​
processDefinitionId
string

Restricts to identity links that have the given process definition id.

​
processDefinitionKey
string

Restricts to identity links that have the given process definition key.

​
operationType
string

Restricts to identity links that have the given operationType (add/delete).

​
assignerId
string

Restricts to identity links that have the given assigner id.

​
tenantIdIn
string

Filter by a comma-separated list of tenant ids.

​
withoutTenantId
boolean

Only include historic identity links that belong to no tenant. Value may only be true, as false is the default behavior.

​
sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
time,
type,
userId,
groupId,
taskId,
processDefinitionId,
processDefinitionKey,
operationType,
assignerId,
tenantId
​
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

​
id
string | null

Id of the Historic identity link entry.

​
time
string<date-time> | null

The time when the identity link is logged. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

​
type
string | null

The type of identity link (candidate/assignee/owner).

​
userId
string | null

The id of the user/assignee.

​
groupId
string | null

The id of the group.

​
taskId
string | null

The id of the task.

​
processDefinitionId
string | null

The id of the process definition.

​
processDefinitionKey
string | null

The key of the process definition.

​
operationType
string | null

Type of operation (add/delete).

​
assignerId
string | null

The id of the assigner.

​
tenantId
string | null

The id of the tenant.

​
removalTime
string<date-time> | null

The time after which the identity link should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

​
rootProcessInstanceId
string | null

The process instance id of the root process instance that initiated the process containing this identity link.