> ## 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 the executions that fulfill given parameters.
Parameters may be static as well as dynamic runtime properties of
executions.
The size of the result set can be retrieved by using the [Get
Execution Count](https://docs.camunda.org/manual/7.22/reference/rest/execution/get-query-count/)
method.



## OpenAPI

````yaml GET /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:
    get:
      tags:
        - Execution
      summary: Get Executions
      description: >-
        Queries for the executions that fulfill given parameters.

        Parameters may be static as well as dynamic runtime properties of

        executions.

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

        Execution
        Count](https://docs.camunda.org/manual/7.22/reference/rest/execution/get-query-count/)

        method.
      operationId: getExecutions
      parameters:
        - name: businessKey
          in: query
          schema:
            type: string
          description: >-
            Filter by the business key of the process instances the executions
            belong to.
        - name: processDefinitionId
          in: query
          schema:
            type: string
          description: Filter by the process definition the executions run on.
        - name: processDefinitionKey
          in: query
          schema:
            type: string
          description: Filter by the key of the process definition the executions run on.
        - name: processInstanceId
          in: query
          schema:
            type: string
          description: Filter by the id of the process instance the execution belongs to.
        - name: activityId
          in: query
          schema:
            type: string
          description: Filter by the id of the activity the execution currently executes.
        - name: signalEventSubscriptionName
          in: query
          schema:
            type: string
          description: Select only those executions that expect a signal of the given name.
        - name: messageEventSubscriptionName
          in: query
          schema:
            type: string
          description: >-
            Select only those executions that expect a message of the given
            name.
        - name: active
          in: query
          schema:
            type: boolean
          description: >-
            Only include active executions. Value may only be `true`, as `false`
            is the default

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

            behavior.
        - name: incidentId
          in: query
          schema:
            type: string
          description: Filter by the incident id.
        - name: incidentType
          in: query
          schema:
            type: string
          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.
        - name: incidentMessage
          in: query
          schema:
            type: string
          description: Filter by the incident message. Exact match.
        - name: incidentMessageLike
          in: query
          schema:
            type: string
          description: Filter by the incident message that the parameter is a substring of.
        - name: tenantIdIn
          in: query
          schema:
            type: string
          description: >-
            Filter by a comma-separated list of tenant ids. An execution must
            have one of the given

            tenant ids.
        - name: variables
          in: query
          schema:
            type: string
          description: >-
            Only include executions that have variables with certain values.

            Variable filtering expressions are comma-separated and are
            structured as

            follows:


            A valid parameter value has the form `key_operator_value`.

            `key` is the variable name, `operator` is the comparison operator to
            be used

            and `value` the variable value.

            **Note:** Values are always treated as `String` objects on server
            side.


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

            `key` and `value` may not contain underscore or comma characters.
        - name: processVariables
          in: query
          schema:
            type: string
          description: >-
            Only include executions that belong to a process instance with
            variables with certain

            values.

            Variable filtering expressions are comma-separated and are
            structured as

            follows:


            A valid parameter value has the form `key_operator_value`.

            `key` is the variable name, `operator` is the comparison operator to
            be used

            and `value` the variable value.

            **Note:** Values are always treated as `String` objects on server
            side.


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

            `key` and `value` may not contain underscore or comma characters.
        - name: variableNamesIgnoreCase
          in: query
          schema:
            type: boolean
          description: >-
            Match all variable names provided in `variables` and
            `processVariables` case-

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

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

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

            treated as equal.
        - name: sortBy
          in: query
          schema:
            enum:
              - instanceId
              - definitionKey
              - definitionId
              - tenantId
            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/ExecutionDto'
              examples:
                example-1:
                  summary: Status 200.
                  description: GET `/execution?variables=myVariable_eq_camunda`
                  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:
    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).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````