> ## 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 executions that fulfill given parameters through a JSON object.
This method is slightly more powerful than the [Get
Executions](https://docs.camunda.org/manual/7.22/reference/rest/execution/get-query/) method
because it allows
to filter by multiple instance and execution variables of types
`String`, `Number` or `Boolean`.



## OpenAPI

````yaml POST /execution
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:
  /execution:
    post:
      tags:
        - Execution
      summary: Get Executions (POST)
      description: >-
        Queries for executions that fulfill given parameters through a JSON
        object.

        This method is slightly more powerful than the [Get

        Executions](https://docs.camunda.org/manual/7.22/reference/rest/execution/get-query/)
        method

        because it allows

        to filter by multiple instance and execution variables of types

        `String`, `Number` or `Boolean`.
      operationId: queryExecutions
      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/ExecutionQueryDto'
            examples:
              example-1:
                summary: POST `/execution`
                value:
                  variables:
                    - name: myVariable
                      operator: eq
                      value: camunda
                    - name: mySecondVariable
                      operator: neq
                      value: 124
                  processDefinitionId: aProcessDefinitionId
                  sorting:
                    - sortBy: definitionKey
                      sortOrder: asc
                    - sortBy: instanceId
                      sortOrder: desc
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExecutionDto'
              examples:
                example-1:
                  summary: Status 200.
                  description: POST `/execution`
                  value:
                    - id: anId
                      processInstanceId: aProcInstId
                      ended: false
                      tenantId: null
          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`, or if an invalid operator

            for variable comparison is used. See the

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

            for the error response format.
components:
  schemas:
    ExecutionQueryDto:
      type: object
      description: A Execution instance query which defines a list of Execution instances
      properties:
        businessKey:
          type: string
          nullable: true
          description: >-
            Filter by the business key of the process instances the executions
            belong to.
        processDefinitionId:
          type: string
          nullable: true
          description: Filter by the process definition the executions run on.
        processDefinitionKey:
          type: string
          nullable: true
          description: Filter by the key of the process definition the executions run on.
        processInstanceId:
          type: string
          nullable: true
          description: Filter by the id of the process instance the execution belongs to.
        activityId:
          type: string
          nullable: true
          description: Filter by the id of the activity the execution currently executes.
        signalEventSubscriptionName:
          type: string
          nullable: true
          description: Select only those executions that expect a signal of the given name.
        messageEventSubscriptionName:
          type: string
          nullable: true
          description: >-
            Select only those executions that expect a message of the given
            name.
        active:
          type: boolean
          nullable: true
          description: >-
            Only include active executions. Value may only be `true`, as `false`
            is the default

            behavior.
        suspended:
          type: boolean
          nullable: true
          description: >-
            Only include suspended executions. Value may only be `true`, as
            `false` is the default

            behavior.
        incidentId:
          type: string
          nullable: true
          description: Filter by the incident id.
        incidentType:
          type: string
          nullable: true
          description: >-
            Filter by the incident type. See the [User
            Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types)
            for a list of incident types.
        incidentMessage:
          type: string
          nullable: true
          description: Filter by the incident message. Exact match.
        incidentMessageLike:
          type: string
          nullable: true
          description: Filter by the incident message that the parameter is a substring of.
        tenantIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Filter by a  list of tenant ids. An execution must have one of the
            given

            tenant ids.
        variables:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/VariableQueryParameterDto'
          description: >-
            An array to only include executions that have variables with certain
            values.


            The array consists of objects with the three properties `name`,
            `operator`

            and `value`.

            `name (String)` is the variable name, `operator (String)` is the
            comparison

            operator to be used and `value` the variable value.

            `value` may be `String`, `Number` or `Boolean`.


            Valid operator values are: `eq` - equal to; `neq` - not equal to;
            `gt` -

            greater than;

            `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower
            than or

            equal to;

            `like`.
        processVariables:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/VariableQueryParameterDto'
          description: >-
            An array to only include executions that belong to a process
            instance with variables

            with certain values.


            The array consists of objects with the three properties `name`,
            `operator`

            and `value`.

            `name (String)` is the variable name, `operator (String)` is the
            comparison

            operator to be used and `value` the variable value.

            `value` may be `String`, `Number` or `Boolean`.


            Valid operator values are: `eq` - equal to; `neq` - not equal to.
        variableNamesIgnoreCase:
          type: boolean
          nullable: true
          description: >-
            Match all variable names provided in `variables` and
            `processVariables` case-

            insensitively. If set to `true` **variableName** and
            **variablename** are

            treated as equal.
        variableValuesIgnoreCase:
          type: boolean
          nullable: true
          description: >-
            Match all variable values provided in `variables` and
            `processVariables` case-

            insensitively. If set to `true` **variableValue** and
            **variablevalue** are

            treated as equal.
        sorting:
          type: array
          nullable: true
          description: >-
            An array of criteria to sort the result by. Each element of the
            array is
                                   an object that specifies one ordering. The position in the array
                                   identifies the rank of an ordering, i.e., whether it is primary, secondary,
                                   etc. Has no effect for the `/count` endpoint
          items:
            type: object
            properties:
              sortBy:
                type: string
                nullable: true
                enum:
                  - instanceId
                  - definitionKey
                  - definitionId
                  - 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.
    ExecutionDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the Execution.
        processInstanceId:
          type: string
          nullable: true
          description: >-
            The id of the root of the execution tree representing the process
            instance.
        ended:
          type: boolean
          nullable: true
          description: Indicates if the execution is ended.
        tenantId:
          type: string
          nullable: true
          description: |-
            The id of the tenant this execution belongs to. Can be `null`
            if the execution belongs to no single tenant.
    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).
    VariableQueryParameterDto:
      allOf:
        - type: object
          properties:
            name:
              type: string
              nullable: true
              description: Variable name
        - $ref: '#/components/schemas/ConditionQueryParameterDto'
    ConditionQueryParameterDto:
      type: object
      properties:
        operator:
          type: string
          nullable: true
          enum:
            - eq
            - neq
            - gt
            - gteq
            - lt
            - lteq
            - like
            - notLike
          description: >-
            Comparison operator to be used. `notLike` is not supported by all
            endpoints.
        value:
          $ref: '#/components/schemas/AnyValue'
    AnyValue:
      description: |-
        Can be any value - string, number, boolean, array or object.
         **Note**: Not every endpoint supports every type.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````