> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eorion.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取列表

> 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](https://docs.camunda.org/manual/7.22/reference/rest/history/user-operation-log/get-user-operation-log-query-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.



## OpenAPI

````yaml GET /history/user-operation
openapi: 3.0.2
info:
  title: ORION Platform REST API
  description: OpenApi Spec for ORION Camunda Platform REST API.
  version: 7.22.6-ee
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ORION Rest API
  url: https://docs.eorion.com
paths:
  /history/user-operation:
    get:
      tags:
        - Historic User Operation Log
      summary: Get User Operation Log (Historic)
      description: >-
        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](https://docs.camunda.org/manual/7.22/reference/rest/history/user-operation-log/get-user-operation-log-query-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.
      operationId: queryUserOperationEntries
      parameters:
        - name: deploymentId
          in: query
          schema:
            type: string
          description: Filter by deployment id.
        - name: processDefinitionId
          in: query
          schema:
            type: string
          description: Filter by process definition id.
        - name: processDefinitionKey
          in: query
          schema:
            type: string
          description: Filter by process definition key.
        - name: processInstanceId
          in: query
          schema:
            type: string
          description: Filter by process instance id.
        - name: executionId
          in: query
          schema:
            type: string
          description: Filter by execution id.
        - name: caseDefinitionId
          in: query
          schema:
            type: string
          description: Filter by case definition id.
        - name: caseInstanceId
          in: query
          schema:
            type: string
          description: Filter by case instance id.
        - name: caseExecutionId
          in: query
          schema:
            type: string
          description: Filter by case execution id.
        - name: taskId
          in: query
          schema:
            type: string
          description: Only include operations on this task.
        - name: externalTaskId
          in: query
          schema:
            type: string
          description: Only include operations on this external task.
        - name: batchId
          in: query
          schema:
            type: string
          description: Only include operations on this batch.
        - name: jobId
          in: query
          schema:
            type: string
          description: Filter by job id.
        - name: jobDefinitionId
          in: query
          schema:
            type: string
          description: Filter by job definition id.
        - name: userId
          in: query
          schema:
            type: string
          description: Only include operations of this user.
        - name: operationId
          in: query
          schema:
            type: string
          description: >-
            Filter by the id of the operation. This allows fetching of multiple
            entries which are part

            of a composite operation.
        - name: operationType
          in: query
          schema:
            type: string
          description: >-
            Filter by the type of the operation like `Claim` or `Delegate`. See
            the

            [Javadoc](https://docs.camunda.org/manual/7.22/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html)

            for a list of available operation types.
        - name: entityType
          in: query
          schema:
            type: string
          description: >-
            Filter by the type of the entity that was affected by this
            operation, possible values are

            `Task`, `Attachment` or `IdentityLink`.
        - name: entityTypeIn
          in: query
          schema:
            type: string
          description: >-
            Filter by a comma-separated list of types of the entities that was
            affected by this operation,

            possible values are `Task`, `Attachment` or `IdentityLink`.
        - name: category
          in: query
          schema:
            type: string
          description: >-
            Filter by the category that this operation is associated with,
            possible values are

            `TaskWorker`, `Admin` or `Operator`.
        - name: categoryIn
          in: query
          schema:
            type: string
          description: >-
            Filter by a comma-separated list of categories that this operation
            is associated with, possible values are

            `TaskWorker`, `Admin` or `Operator`.
        - name: property
          in: query
          schema:
            type: string
          description: >-
            Only include operations that changed this property, e.g., `owner` or
            `assignee`.
        - name: afterTimestamp
          in: query
          schema:
            type: string
            format: date-time
          description: >-
            Restrict to entries that were created after the given timestamp. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),
            the

            timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,

            e.g., 2013-01-23T14:42:45.000+0200.
        - name: beforeTimestamp
          in: query
          schema:
            type: string
            format: date-time
          description: >-
            Restrict to entries that were created before the given timestamp. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),
            the

            timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`,

            e.g., 2013-01-23T14:42:45.000+0200.
        - name: sortBy
          in: query
          schema:
            enum:
              - timestamp
            type: string
          description: |-
            Sort the results lexicographically by a given criterion.
            Must be used in conjunction with the sortOrder parameter.
        - name: sortOrder
          in: query
          schema:
            enum:
              - asc
              - desc
            type: string
          description: >-
            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.
        - name: firstResult
          in: query
          schema:
            type: integer
          description: >-
            Pagination of results. Specifies the index of the first result to
            return.
        - name: maxResults
          in: query
          schema:
            type: integer
          description: >-
            Pagination of results. Specifies the maximum number of results to
            return.

            Will return less results if there are no more results left.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserOperationLogEntryDto'
              examples:
                example-1:
                  summary: Gets an operation that updates a single task.
                  description: >-
                    GET
                    `/history/user-operation?operationType=Claim&userId=demo&sortBy=timestamp&sortOrder=asc`
                  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
                example-2:
                  summary: >-
                    Gets an operation that updates a multiple process instances
                    with the same key.
                  description: >-
                    GET
                    `/history/user-operation?operationType=Suspend&userId=demo`
                  value:
                    - id: anUserOperationLogEntryId
                      deploymentId: aDeploymentId
                      processDefinitionId: aProcessDefinitionId
                      processDefinitionKey: aProcessDefinitionKey
                      processInstanceId: null
                      executionId: null
                      taskId: null
                      jobId: null
                      jobDefinitionId: null
                      userId: demo
                      timestamp: 2014-02-25T14:58:37.000+0200
                      operationId: anOperationId
                      operationType: Suspend
                      entityType: ProcessInstance
                      property: suspensionState
                      orgValue: null
                      newValue: suspended
                      removalTime: 2018-02-10T14:33:19.000+0200
                      rootProcessInstanceId: aRootProcessInstanceId
                      category: Operator
                      annotation: anAnnotation
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Returned if some of the query parameters are invalid, for example if
            a `sortOrder`

            parameter is supplied, but no `sortBy`. See the

            [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling)

            for the error response format.
components:
  schemas:
    UserOperationLogEntryDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The unique identifier of this log entry.
        userId:
          type: string
          nullable: true
          description: The user who performed this operation.
        timestamp:
          type: string
          format: date-time
          nullable: true
          description: Timestamp of this operation.
        operationId:
          type: string
          nullable: true
          description: >-
            The unique identifier of this operation. A composite operation that
            changes

            multiple properties has a common `operationId`.
        operationType:
          type: string
          nullable: true
          description: The type of this operation, e.g., `Assign`, `Claim` and so on.
        entityType:
          type: string
          nullable: true
          description: >-
            The type of the entity on which this operation was executed, e.g.,
            `Task` or

            `Attachment`.
        category:
          type: string
          nullable: true
          description: >-
            The name of the category this operation was associated with, e.g.,
            `TaskWorker` or

            `Admin`.
        annotation:
          type: string
          nullable: true
          description: An arbitrary annotation set by a user for auditing reasons.
        property:
          type: string
          nullable: true
          description: The property changed by this operation.
        orgValue:
          type: string
          nullable: true
          description: The original value of the changed property.
        newValue:
          type: string
          nullable: true
          description: The new value of the changed property.
        deploymentId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this

            deployment.
        processDefinitionId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this process

            definition.
        processDefinitionKey:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to process

            definitions with this key.
        processInstanceId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this process

            instance.
        executionId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this

            execution.
        caseDefinitionId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this case

            definition.
        caseInstanceId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this case

            instance.
        caseExecutionId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this case

            execution.
        taskId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this task.
        externalTaskId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this external task.
        batchId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this batch.
        jobId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this job.
        jobDefinitionId:
          type: string
          nullable: true
          description: >-
            If not `null`, the operation is restricted to entities in relation
            to this job

            definition.
        removalTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time after which the entry should be removed by the History
            Cleanup job.

            [Default
            format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        rootProcessInstanceId:
          type: string
          nullable: true
          description: >-
            The process instance id of the root process instance that initiated
            the process

            containing this entry.
    ExceptionDto:
      title: ExceptionDto
      type: object
      properties:
        type:
          type: string
          nullable: true
          description: An exception class indicating the occurred error.
        message:
          type: string
          nullable: true
          description: A detailed message of the error.
        code:
          type: number
          description: >-
            The code allows your client application to identify the error in an
            automated fashion.

            You can look up the meaning of all built-in codes and learn how to
            add custom codes

            in the [User
            Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/error-handling/#exception-codes).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````