Get User Operation Log (Historic)

curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/user-operation \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "id": "anUserOperationLogEntryId",
    "deploymentId": "aDeploymentId",
    "processDefinitionId": "aProcessDefinitionId",
    "processDefinitionKey": null,
    "processInstanceId": "aProcessInstanceId",
    "executionId": "anExecutionId",
    "taskId": "aTaskId",
    "jobId": "aJobId",
    "jobDefinitionId": "aJobDefinitionId",
    "userId": "demo",
    "timestamp": "2014-02-25T14:58:37.000+0200",
    "operationId": "anOperationId",
    "operationType": "Claim",
    "entityType": "Task",
    "property": "assignee",
    "orgValue": null,
    "newValue": "demo",
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId",
    "category": "TaskWorker",
    "annotation": "anAnnotation"
  }
]

历史用户操作日志

获取列表

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

Get User Operation Log (Historic)

curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/user-operation \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "id": "anUserOperationLogEntryId",
    "deploymentId": "aDeploymentId",
    "processDefinitionId": "aProcessDefinitionId",
    "processDefinitionKey": null,
    "processInstanceId": "aProcessInstanceId",
    "executionId": "anExecutionId",
    "taskId": "aTaskId",
    "jobId": "aJobId",
    "jobDefinitionId": "aJobDefinitionId",
    "userId": "demo",
    "timestamp": "2014-02-25T14:58:37.000+0200",
    "operationId": "anOperationId",
    "operationType": "Claim",
    "entityType": "Task",
    "property": "assignee",
    "orgValue": null,
    "newValue": "demo",
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId",
    "category": "TaskWorker",
    "annotation": "anAnnotation"
  }
]

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

deploymentId

string

Filter by deployment id.

processDefinitionId

string

Filter by process definition id.

processDefinitionKey

string

Filter by process definition key.

processInstanceId

string

Filter by process instance id.

executionId

string

Filter by execution id.

caseDefinitionId

string

Filter by case definition id.

caseInstanceId

string

Filter by case instance id.

caseExecutionId

string

Filter by case execution id.

taskId

string

Only include operations on this task.

externalTaskId

string

Only include operations on this external task.

batchId

string

Only include operations on this batch.

jobId

string

Filter by job id.

jobDefinitionId

string

Filter by job definition id.

userId

string

Only include operations of this user.

operationId

string

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

operationType

string

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

entityType

string

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

entityTypeIn

string

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

category

string

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

categoryIn

string

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

property

string

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

afterTimestamp

string<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.

beforeTimestamp

string<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

enum<string>

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

Available options:

timestamp

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

The unique identifier of this log entry.

userId

string | null

The user who performed this operation.

timestamp

string<date-time> | null

Timestamp of this operation.

operationId

string | null

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

operationType

string | null

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

entityType

string | null

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

category

string | null

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

annotation

string | null

An arbitrary annotation set by a user for auditing reasons.

property

string | null

The property changed by this operation.

orgValue

string | null

The original value of the changed property.

newValue

string | null

The new value of the changed property.

deploymentId

string | null

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

processDefinitionId

string | null

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

processDefinitionKey

string | null

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

processInstanceId

string | null

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

executionId

string | null

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

caseDefinitionId

string | null

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

caseInstanceId

string | null

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

caseExecutionId

string | null

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

taskId

string | null

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

externalTaskId

string | null

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

batchId

string | null

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

jobId

string | null

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

jobDefinitionId

string | null

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

removalTime

string<date-time> | null

The time after which the entry 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 entry.

获取可清理的流程实例报告获取计数

⌘I