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

# 获取列表(POST)

> Queries for historic activity instances that fulfill the given parameters.
The size of the result set can be retrieved by using the
[Get Historic Activity Instance Count](https://docs.camunda.org/manual/7.22/reference/rest/history/activity-instance/get-activity-instance-query-count/) method.



## OpenAPI

````yaml POST /history/activity-instance
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/activity-instance:
    post:
      tags:
        - Historic Activity Instance
      summary: Get List (POST)
      description: >-
        Queries for historic activity instances that fulfill the given
        parameters.

        The size of the result set can be retrieved by using the

        [Get Historic Activity Instance
        Count](https://docs.camunda.org/manual/7.22/reference/rest/history/activity-instance/get-activity-instance-query-count/)
        method.
      operationId: queryHistoricActivityInstances
      parameters:
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricActivityInstanceQueryDto'
            examples:
              example-1:
                summary: POST `/history/activity-instance`
                value:
                  activityType: userTask
                  taskAssignee: peter
                  sorting:
                    - sortBy: activityId
                      sortOrder: asc
                    - sortBy: executionId
                      sortOrder: desc
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricActivityInstanceDto'
              examples:
                example-1:
                  summary: Status 200 Response 1
                  value:
                    - activityId: anActivity
                      activityName: anActivityName
                      activityType: userTask
                      assignee: peter
                      calledProcessInstanceId: aHistoricCalledProcessInstanceId
                      calledCaseInstanceId: null
                      canceled: true
                      completeScope: false
                      durationInMillis: 2000
                      endTime: 2013-04-23T18:42:43.000+0200
                      executionId: anExecutionId
                      id: aHistoricActivityInstanceId
                      parentActivityInstanceId: aHistoricParentActivityInstanceId
                      processDefinitionId: aProcDefId
                      processInstanceId: aProcInstId
                      startTime: 2013-04-23T11:20:43.000+0200
                      taskId: aTaskId
                      tenantId: null
                      removalTime: 2018-02-10T14:33:19.000+0200
                      rootProcessInstanceId: aRootProcessInstanceId
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Bad Request

            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:
    HistoricActivityInstanceQueryDto:
      type: object
      description: >-
        A historic activity instance query which defines a group of historic
        activity instances
      properties:
        activityInstanceId:
          type: string
          nullable: true
          description: Filter by activity instance id.
        processInstanceId:
          type: string
          nullable: true
          description: Filter by process instance id.
        processDefinitionId:
          type: string
          nullable: true
          description: Filter by process definition id.
        executionId:
          type: string
          nullable: true
          description: >-
            Filter by the id of the execution that executed the activity
            instance.
        activityId:
          type: string
          nullable: true
          description: Filter by the activity id (according to BPMN 2.0 XML).
        activityName:
          type: string
          nullable: true
          description: Filter by the activity name (according to BPMN 2.0 XML).
        activityType:
          type: string
          nullable: true
          description: Filter by activity type.
        taskAssignee:
          type: string
          nullable: true
          description: >-
            Only include activity instances that are user tasks and assigned to
            a given user.
        finished:
          type: boolean
          nullable: true
          description: >-
            Only include finished activity instances.

            Value may only be `true`, as `false` behaves the same as when the
            property is not set.
        unfinished:
          type: boolean
          nullable: true
          description: >-
            Only include unfinished activity instances.

            Value may only be `true`, as `false` behaves the same as when the
            property is not set.
        canceled:
          type: boolean
          nullable: true
          description: >-
            Only include canceled activity instances.

            Value may only be `true`, as `false` behaves the same as when the
            property is not set.
        completeScope:
          type: boolean
          nullable: true
          description: >-
            Only include activity instances which completed a scope.

            Value may only be `true`, as `false` behaves the same as when the
            property is not set.
        startedBefore:
          type: string
          format: date-time
          nullable: true
          description: >-
            Restrict to instances that were started before the given date. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
            `2013-01-23T14:42:45.000+0200`.
        startedAfter:
          type: string
          format: date-time
          nullable: true
          description: >-
            Restrict to instances that were started after the given date. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
            `2013-01-23T14:42:45.000+0200`.
        finishedBefore:
          type: string
          format: date-time
          nullable: true
          description: >-
            Restrict to instances that were finished before the given date. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
            `2013-01-23T14:42:45.000+0200`.
        finishedAfter:
          type: string
          format: date-time
          nullable: true
          description: >-
            Restrict to instances that were finished after the given date. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
            `2013-01-23T14:42:45.000+0200`.
        tenantIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Must be a JSON array of Strings. An activity instance must have one
            of the given tenant ids.
        withoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Only include historic activity instances that belong to no tenant.
            Value may only be `true`, as `false` is the default behavior.
        sorting:
          type: array
          nullable: true
          description: Apply sorting of the result
          items:
            type: object
            properties:
              sortBy:
                type: string
                nullable: true
                enum:
                  - activityInstanceId
                  - instanceId
                  - executionId
                  - activityId
                  - activityName
                  - activityType
                  - startTime
                  - endTime
                  - duration
                  - definitionId
                  - occurrence
                  - tenantId
                description: |-
                  Sort the results lexicographically by a given criterion.
                  Must be used in conjunction with the sortOrder parameter.
              sortOrder:
                type: string
                nullable: true
                enum:
                  - asc
                  - desc
                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.
    HistoricActivityInstanceDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the activity instance.
        parentActivityInstanceId:
          type: string
          nullable: true
          description: >-
            The id of the parent activity instance, for example a sub process
            instance.
        activityId:
          type: string
          nullable: true
          description: The id of the activity that this object is an instance of.
        activityName:
          type: string
          nullable: true
          description: The name of the activity that this object is an instance of.
        activityType:
          type: string
          nullable: true
          description: The type of the activity that this object is an instance of.
        processDefinitionKey:
          type: string
          nullable: true
          description: >-
            The key of the process definition that this activity instance
            belongs to.
        processDefinitionId:
          type: string
          nullable: true
          description: >-
            The id of the process definition that this activity instance belongs
            to.
        processInstanceId:
          type: string
          nullable: true
          description: >-
            The id of the process instance that this activity instance belongs
            to.
        executionId:
          type: string
          nullable: true
          description: The id of the execution that executed this activity instance.
        taskId:
          type: string
          nullable: true
          description: >-
            The id of the task that is associated to this activity instance. Is
            only set if the activity is a user task.
        assignee:
          type: string
          nullable: true
          description: >-
            The assignee of the task that is associated to this activity
            instance. Is only set if the activity is a user task.
        calledProcessInstanceId:
          type: string
          nullable: true
          description: >-
            The id of the called process instance. Is only set if the activity
            is a call activity and the called instance a process instance.
        calledCaseInstanceId:
          type: string
          nullable: true
          description: >-
            The id of the called case instance. Is only set if the activity is a
            call activity and the called instance a case instance.
        startTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time the instance was started. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
            `2013-01-23T14:42:45.000+0200`.
        endTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time the instance ended. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
            `2013-01-23T14:42:45.000+0200`.
        durationInMillis:
          type: integer
          format: int64
          nullable: true
          description: The time the instance took to finish (in milliseconds).
        canceled:
          type: boolean
          nullable: true
          description: If `true`, this activity instance is canceled.
        completeScope:
          type: boolean
          nullable: true
          description: If `true`, this activity instance did complete a BPMN 2.0 scope.
        tenantId:
          type: string
          nullable: true
          description: The tenant id of the activity instance.
        removalTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time after which the activity instance should be removed by the
            History Cleanup job. By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),

            the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,
            `2013-01-23T14:42:45.000+0200`.
        rootProcessInstanceId:
          type: string
          nullable: true
          description: >-
            The process instance id of the root process instance that initiated
            the process containing this activity instance.
    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

````