> ## 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 details that fulfill the given parameters. This method is slightly more
powerful than the [Get Historic Details](https://docs.camunda.org/manual/7.22/reference/rest/history/detail/get-detail-query/)
method because it allows sorting by multiple parameters. The size of the result set can be retrieved by
using the [Get Historic Detail Count](https://docs.camunda.org/manual/7.22/reference/rest/history/detail/get-detail-query-count/)
method.



## OpenAPI

````yaml POST /history/detail
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/detail:
    post:
      tags:
        - Historic Detail
      summary: Get Historic Details (POST)
      description: >-
        Queries for historic details that fulfill the given parameters. This
        method is slightly more

        powerful than the [Get Historic
        Details](https://docs.camunda.org/manual/7.22/reference/rest/history/detail/get-detail-query/)

        method because it allows sorting by multiple parameters. The size of the
        result set can be retrieved by

        using the [Get Historic Detail
        Count](https://docs.camunda.org/manual/7.22/reference/rest/history/detail/get-detail-query-count/)

        method.
      operationId: queryHistoricDetails
      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.
        - name: deserializeValues
          in: query
          schema:
            type: boolean
          description: >-
            Determines whether serializable variable values (typically variables
            that

            store custom Java objects) should be deserialized on server side
            (default

            `true`).


            If set to `true`, a serializable variable will be deserialized on
            server side

            and transformed to JSON using

            [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property

            introspection feature. Note that this requires the Java classes of
            the

            variable value to be on the REST API's classpath.


            If set to `false`, a serializable variable will be returned in its
            serialized

            format. For example, a variable that is serialized as XML will be
            returned as

            a JSON string containing XML.


            **Note:** While `true` is the default value for reasons of backward

            compatibility, we recommend setting this parameter to `false` when
            developing

            web applications that are independent of the Java process
            applications

            deployed to the engine.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricDetailQueryDto'
            examples:
              example-1:
                summary: POST `/history/detail?firstResult=1&maxResults=10`
                description: POST `/history/detail?firstResult=1&maxResults=10`
                value:
                  processInstanceId: 3cd597b7-001a-11e7-8c6b-34f39ab71d4e
                  occurredAfter: 2018-01-29T10:15:45.000+0100
                  sorting:
                    - sortBy: processInstanceId
                      sortOrder: asc
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricDetailDto'
              examples:
                example-1:
                  summary: POST `/history/detail?firstResult=1&maxResults=10`
                  description: POST `/history/detail?firstResult=1&maxResults=10`
                  value:
                    - type: variableUpdate
                      id: 3cd79390-001a-11e7-8c6b-34f39ab71d4e
                      processDefinitionKey: invoice
                      processDefinitionId: invoice:1:3c59899b-001a-11e7-8c6b-34f39ab71d4e
                      processInstanceId: 3cd597b7-001a-11e7-8c6b-34f39ab71d4e
                      activityInstanceId: StartEvent_1:3cd7456e-001a-11e7-8c6b-34f39ab71d4e
                      executionId: 3cd597b7-001a-11e7-8c6b-34f39ab71d4e
                      caseDefinitionKey: null
                      caseDefinitionId: null
                      caseInstanceId: null
                      caseExecutionId: null
                      taskId: null
                      tenantId: null
                      userOperationId: 3cd76c7f-001a-11e7-8c6b-34f39ab71d4e
                      time: 2017-03-03T15:03:54.000+0200
                      variableName: amount
                      variableInstanceId: 3cd65b08-001a-11e7-8c6b-34f39ab71d4e
                      variableType: Double
                      value: 30
                      valueInfo: {}
                      revision: 0
                      errorMessage: null
                      removalTime: 2018-02-10T14:33:19.000+0200
                      rootProcessInstanceId: aRootProcessInstanceId
                      initial: true
                    - type: variableUpdate
                      id: 3cd79392-001a-11e7-8c6b-34f39ab71d4e
                      processDefinitionKey: invoice
                      processDefinitionId: invoice:1:3c59899b-001a-11e7-8c6b-34f39ab71d4e
                      processInstanceId: 3cd597b7-001a-11e7-8c6b-34f39ab71d4e
                      activityInstanceId: StartEvent_1:3cd7456e-001a-11e7-8c6b-34f39ab71d4e
                      executionId: 3cd597b7-001a-11e7-8c6b-34f39ab71d4e
                      caseDefinitionKey: null
                      caseDefinitionId: null
                      caseInstanceId: null
                      caseExecutionId: null
                      taskId: null
                      tenantId: null
                      userOperationId: 3cd76c7f-001a-11e7-8c6b-34f39ab71d4e
                      time: 2017-03-03T15:03:54.000+0200
                      variableName: invoiceDocument
                      variableInstanceId: 3cd65b0a-001a-11e7-8c6b-34f39ab71d4e
                      variableType: File
                      value: null
                      valueInfo:
                        mimeType: application/pdf
                        filename: invoice.pdf
                      revision: 0
                      errorMessage: null
                      removalTime: 2018-02-10T14:33:19.000+0200
                      rootProcessInstanceId: aRootProcessInstanceId
                      initial: true
          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:
    HistoricDetailQueryDto:
      type: object
      description: A historic detail query which defines a group of historic details.
      properties:
        processInstanceId:
          type: string
          nullable: true
          description: Filter by process instance id.
        processInstanceIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Only include historic details which belong to one of the passed 
            process instance ids.
        executionId:
          type: string
          nullable: true
          description: Filter by execution id.
        taskId:
          type: string
          nullable: true
          description: Filter by task id.
        activityInstanceId:
          type: string
          nullable: true
          description: Filter by activity instance id.
        caseInstanceId:
          type: string
          nullable: true
          description: Filter by case instance id.
        caseExecutionId:
          type: string
          nullable: true
          description: Filter by case execution id.
        variableInstanceId:
          type: string
          nullable: true
          description: Filter by variable instance id.
        variableTypeIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Only include historic details where the variable updates belong to
            one of the passed 

            list of variable types. A list of all supported variable types can
            be found

            [here](https://docs.camunda.org/manual/7.22/user-guide/process-engine/variables/#supported-variable-values).

            **Note:** All non-primitive variables are associated with the type
            `serializable`.
        variableNameLike:
          type: string
          nullable: true
          description: >-
            Filter by variable name like. Example usage:
            `variableNameLike(%camunda%)`. The query will match the names of
            variables in a case-insensitive way.
        tenantIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: Filter by a  list of tenant ids.
        withoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Only include historic details that belong to no tenant. Value may
            only be

            `true`, as `false` is the default behavior.
        userOperationId:
          type: string
          nullable: true
          description: Filter by a user operation id.
        formFields:
          type: boolean
          nullable: true
          description: >-
            Only include `HistoricFormFields`. Value may only be `true`, as
            `false` is the default behavior.
        variableUpdates:
          type: boolean
          nullable: true
          description: >-
            Only include `HistoricVariableUpdates`. Value may only be `true`, as
            `false` is the default behavior.
        excludeTaskDetails:
          type: boolean
          nullable: true
          description: >-
            Excludes all task-related `HistoricDetails`, so only items which
            have no task id set will be selected.

            When this parameter is used together with `taskId`, this call is
            ignored and task details are not excluded.

            Value may only be `true`, as `false` is the default behavior.
        initial:
          type: boolean
          nullable: true
          description: >-
            Restrict to historic variable updates that contain only initial
            variable values.

            Value may only be `true`, as `false` is the default behavior.
        occurredBefore:
          type: string
          format: date-time
          nullable: true
          description: >-
            Restrict to historic details that occured before the given date
            (including the date).

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

            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200.
        occurredAfter:
          type: string
          format: date-time
          nullable: true
          description: >-
            Restrict to historic details that occured after the given date
            (including the date).

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

            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200.
        sorting:
          type: array
          nullable: true
          description: >-
            A JSON array of criteria to sort the result by. Each element of the
            array is
                                a JSON object that specifies one ordering. The position in the array
                                identifies the rank of an ordering, i.e., whether it is primary, secondary,
                                etc. Does not have an effect for the `count` endpoint.
          items:
            type: object
            properties:
              sortBy:
                type: string
                nullable: true
                enum:
                  - processInstanceId
                  - variableName
                  - variableType
                  - variableRevision
                  - formPropertyId
                  - time
                  - 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.
    HistoricDetailDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the historic detail.
        type:
          type: string
          nullable: true
          description: >-
            The type of the historic detail. Either `formField` for a submitted
            form field

            value or `variableUpdate` for variable updates.
        processDefinitionKey:
          type: string
          nullable: true
          description: >-
            The key of the process definition that this historic detail belongs
            to.
        processDefinitionId:
          type: string
          nullable: true
          description: >-
            The id of the process definition that this historic detail belongs
            to.
        processInstanceId:
          type: string
          nullable: true
          description: The id of the process instance the historic detail belongs to.
        activityInstanceId:
          type: string
          nullable: true
          description: The id of the activity instance the historic detail belongs to.
        executionId:
          type: string
          nullable: true
          description: The id of the execution the historic detail belongs to.
        caseDefinitionKey:
          type: string
          nullable: true
          description: The key of the case definition that this historic detail belongs to.
        caseDefinitionId:
          type: string
          nullable: true
          description: The id of the case definition that this historic detail belongs to.
        caseInstanceId:
          type: string
          nullable: true
          description: The id of the case instance the historic detail belongs to.
        caseExecutionId:
          type: string
          nullable: true
          description: The id of the case execution the historic detail belongs to.
        taskId:
          type: string
          nullable: true
          description: The id of the task the historic detail belongs to.
        tenantId:
          type: string
          nullable: true
          description: The id of the tenant that this historic detail belongs to.
        userOperationId:
          type: string
          nullable: true
          description: >-
            The id of user operation which links historic detail with

            [user operation
            log](https://docs.camunda.org/manual/7.22/reference/rest/history/user-operation-log/)

            entries.
        time:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time when this historic detail occurred. Default
            [format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        removalTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time after which the historic detail 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 historic detail.
        fieldId:
          type: string
          nullable: true
          description: >-
            The id of the form field.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is `formField`.
        fieldValue:
          type: object
          description: >-
            The submitted form field value. The value differs depending on the
            form field's type

            and on the `deserializeValue` parameter.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is `formField`.
        variableName:
          type: string
          nullable: true
          description: >-
            The name of the variable which has been updated.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is
            `variableUpdate`.
        variableInstanceId:
          type: string
          nullable: true
          description: >-
            The id of the associated variable instance.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is
            `variableUpdate`.
        variableType:
          type: string
          nullable: true
          description: >-
            The value type of the variable.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is
            `variableUpdate`.
        value:
          type: object
          description: >-
            The variable's value. Value differs depending on the variable's type

            and on the deserializeValues parameter.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is
            `variableUpdate`.
        valueInfo:
          type: object
          additionalProperties: true
          description: >-
            A JSON object containing additional, value-type-dependent
            properties.

            For variables of type `Object`, the following properties are
            returned:


            * `objectTypeName`: A string representation of the object's type
            name.

            * `serializationDataFormat`: The serialization format used to store
            the variable.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is
            `variableUpdate`.
        initial:
          type: boolean
          nullable: true
          description: >-
            Returns `true` for variable updates that contains the initial values
            of the variables.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is
            `variableUpdate`.
        revision:
          type: integer
          format: int32
          nullable: true
          description: >-
            The revision of the historic variable update.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is
            `variableUpdate`.
        errorMessage:
          type: string
          nullable: true
          description: >-
            An error message in case a Java Serialized Object

            could not be de-serialized.


            **Note:** This property is only set for a `HistoricVariableUpdate`
            historic details.

            In these cases, the value of the `type` property is
            `variableUpdate`.
    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

````