Authorization9

Batch7

Condition1

Decision Definition17

Decision Requirements Definition11

Deployment10

Engine1

Event Subscription2

Execution16

External Task18

Filter14

Group13

Historic Activity Instance5

Historic Batch7

Historic Decision Definition2

Historic Decision Instance5

Historic Decision Requirements Definition1

Historic Detail5

Historic External Task Log6

Historic Identity Link Log2

Historic Incident2

Historic Job Log6

Historic Process Definition3

Historic Process Instance10

Historic Task Instance5

Historic User Operation Log4

Historic Variable Instance7

History Cleanup4

Identity4

Incident6

Job15

Job Definition9

Message1

Metrics3

Migration4

Modification2

Process Definition46

Process Instance25

Process Instance Comment4

Schema Log2

Signal1

Task22

Task Attachment5

Task Comment6

Task Identity Link3

Task Local Variable7

Task Variable7

Telemetry3

Tenant14

User10

Variable Instance6

Version1

Historic User Operation Log

Get User Operation Log (Historic)

Queries for user operation log entries that fulfill the given parameters. The size of the result set can be retrieved by using the Get User Operation Log Count method.

Note that the properties of operation log entries are interpreted as restrictions on the entities they apply to. That means, if a single process instance is updated, the field processInstanceId is populated. If a single operation updates all process instances of the same process definition, the field processInstanceId is null (a null restriction is viewed as a wildcard, i.e., matches a process instance with any id) and the field processDefinitionId is populated. This way, which entities were changed by a user operation can easily be reconstructed.

get/history/user-operation

Request

Base URL: http://localhost:8080/engine-rest
URL: http://localhost:8080/engine-rest/history/user-operation
Auth: HTTP basic

Query parameters

deploymentIdstring

Filter by deployment id.

processDefinitionIdstring

Filter by process definition id.

processDefinitionKeystring

Filter by process definition key.

processInstanceIdstring

Filter by process instance id.

executionIdstring

Filter by execution id.

caseDefinitionIdstring

Filter by case definition id.

caseInstanceIdstring

Filter by case instance id.

caseExecutionIdstring

Filter by case execution id.

taskIdstring

Only include operations on this task.

externalTaskIdstring

Only include operations on this external task.

batchIdstring

Only include operations on this batch.

jobIdstring

Filter by job id.

jobDefinitionIdstring

Filter by job definition id.

userIdstring

Only include operations of this user.

operationIdstring

Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation.

operationTypestring

Filter by the type of the operation like Claim or Delegate. See the Javadoc for a list of available operation types.

entityTypestring

Filter by the type of the entity that was affected by this operation, possible values are Task, Attachment or IdentityLink.

entityTypeInstring

Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are Task, Attachment or IdentityLink.

categorystring

Filter by the category that this operation is associated with, possible values are TaskWorker, Admin or Operator.

categoryInstring

Filter by a comma-separated list of categories that this operation is associated with, possible values are TaskWorker, Admin or Operator.

propertystring

Only include operations that changed this property, e.g., owner or assignee.

afterTimestampstring date-time

Restrict to entries that were created after the given timestamp. By default, the timestamp must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

beforeTimestampstring date-time

Restrict to entries that were created before the given timestamp. By default, the timestamp must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

sortBy'timestamp'

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

sortOrder'asc' | 'desc'

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.

firstResultinteger

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

maxResultsinteger

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.

idstring nullable

The unique identifier of this log entry.

userIdstring nullable

The user who performed this operation.

timestampstring date-time nullable

Timestamp of this operation.

operationIdstring nullable

The unique identifier of this operation. A composite operation that changes multiple properties has a common operationId.

operationTypestring nullable

The type of this operation, e.g., Assign, Claim and so on.

entityTypestring nullable

The type of the entity on which this operation was executed, e.g., Task or Attachment.

categorystring nullable

The name of the category this operation was associated with, e.g., TaskWorker or Admin.

annotationstring nullable

An arbitrary annotation set by a user for auditing reasons.

propertystring nullable

The property changed by this operation.

orgValuestring nullable

The original value of the changed property.

newValuestring nullable

The new value of the changed property.

deploymentIdstring nullable

If not null, the operation is restricted to entities in relation to this deployment.

processDefinitionIdstring nullable

If not null, the operation is restricted to entities in relation to this process definition.

processDefinitionKeystring nullable

If not null, the operation is restricted to entities in relation to process definitions with this key.

processInstanceIdstring nullable

If not null, the operation is restricted to entities in relation to this process instance.

executionIdstring nullable

If not null, the operation is restricted to entities in relation to this execution.

caseDefinitionIdstring nullable

If not null, the operation is restricted to entities in relation to this case definition.

caseInstanceIdstring nullable

If not null, the operation is restricted to entities in relation to this case instance.

caseExecutionIdstring nullable

If not null, the operation is restricted to entities in relation to this case execution.

taskIdstring nullable

If not null, the operation is restricted to entities in relation to this task.

externalTaskIdstring nullable

If not null, the operation is restricted to entities in relation to this external task.

batchIdstring nullable

If not null, the operation is restricted to entities in relation to this batch.

jobIdstring nullable

If not null, the operation is restricted to entities in relation to this job.

jobDefinitionIdstring nullable

If not null, the operation is restricted to entities in relation to this job definition.

removalTimestring date-time nullable

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

rootProcessInstanceIdstring nullable

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

Changes

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