> ## 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 jobs that fulfill given parameters. This method is slightly more
powerful than the [Get Jobs](https://docs.camunda.org/manual/7.22/reference/rest/job/get-query/)
method because it allows filtering by multiple jobs of types `String`,
`Number` or `Boolean`.



## OpenAPI

````yaml POST /job
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:
  /job:
    post:
      tags:
        - Job
      summary: Get Jobs (POST)
      description: >-
        Queries for jobs that fulfill given parameters. This method is slightly
        more

        powerful than the [Get
        Jobs](https://docs.camunda.org/manual/7.22/reference/rest/job/get-query/)

        method because it allows filtering by multiple jobs of types `String`,

        `Number` or `Boolean`.
      operationId: queryJobs
      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/JobQueryDto'
            examples:
              example-1:
                summary: POST `/job`
                value:
                  dueDates:
                    - operator: gt
                      value: 2018-07-17T17:00:00.000+0200
                    - operator: lt
                      value: 2018-07-17T18:00:00.000+0200
                  createTimes:
                    - operator: gt
                      value: 2012-05-05T10:00:00.000+0200
                    - operator: lt
                      value: 2012-07-16T15:00:00.000+0200
                  sorting:
                    - sortBy: jobDueDate
                      sortOrder: asc
                    - sortBy: jobRetries
                      sortOrder: asc
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JobDto'
              examples:
                example-1:
                  description: POST `/job`
                  value:
                    - id: aJobId
                      jobDefinitionId: aJobDefinitionId
                      dueDate: 2018-07-17T17:05:00.000+0200
                      processInstanceId: aProcessInstanceId
                      processDefinitionId: aProcessDefinitionId
                      processDefinitionKey: aPDKey
                      executionId: anExecutionId
                      retries: 0
                      exceptionMessage: An exception Message
                      failedActivityId: anActivityId
                      suspended: false
                      priority: 10
                      tenantId: null
                      createTime: 2018-05-05T17:00:00+0200
                      batchId: aBatchId
                    - id: anotherJobId
                      jobDefinitionId: anotherJobDefinitionId
                      dueDate: 2018-07-17T17:55:00.000+0200
                      processInstanceId: aProcessInstanceId
                      processDefinitionId: anotherPDId
                      processDefinitionKey: anotherPDKey
                      executionId: anotherExecutionId
                      retries: 0
                      exceptionMessage: Another exception Message
                      failedActivityId: anotherActivityId
                      suspended: true
                      priority: 8
                      tenantId: null
                      createTime: 2018-05-05T17:00:00+0200
                      batchId: 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 due date 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:
    JobQueryDto:
      type: object
      description: A Job instance query which defines a list of Job instances
      properties:
        jobId:
          type: string
          nullable: true
          description: Filter by job id.
        jobIds:
          type: array
          nullable: true
          items:
            type: string
          description: Filter by a  list of job ids.
        jobDefinitionId:
          type: string
          nullable: true
          description: Only select jobs which exist for the given job definition.
        processInstanceId:
          type: string
          nullable: true
          description: Only select jobs which exist for the given process instance.
        processInstanceIds:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Only select jobs which exist for the given  list of process instance
            ids.
        executionId:
          type: string
          nullable: true
          description: Only select jobs which exist for the given execution.
        processDefinitionId:
          type: string
          nullable: true
          description: Filter by the id of the process definition the jobs run on.
        processDefinitionKey:
          type: string
          nullable: true
          description: Filter by the key of the process definition the jobs run on.
        activityId:
          type: string
          nullable: true
          description: Only select jobs which exist for an activity with the given id.
        withRetriesLeft:
          type: boolean
          nullable: true
          description: >-
            Only select jobs which have retries left. Value may only be `true`,
            as `false` is the

            default behavior.
        executable:
          type: boolean
          nullable: true
          description: >-
            Only select jobs which are executable, i.e., retries > 0 and due
            date is `null` or due

            date is in the past. Value may only be `true`, as `false` is the
            default

            behavior.
        timers:
          type: boolean
          nullable: true
          description: >-
            Only select jobs that are timers. Cannot be used together with
            `messages`. Value may only

            be `true`, as `false` is the default behavior.
        messages:
          type: boolean
          nullable: true
          description: >-
            Only select jobs that are messages. Cannot be used together with
            `timers`. Value may only

            be `true`, as `false` is the default behavior.
        dueDates:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/JobConditionQueryParameterDto'
          description: >
            Only select jobs where the due date is lower or higher than the
            given date.
        createTimes:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/JobConditionQueryParameterDto'
          description: |
            Only select jobs created before or after the given date.
        withException:
          type: boolean
          nullable: true
          description: >-
            Only select jobs that failed due to an exception. Value may only be
            `true`, as `false` is

            the default behavior.
        exceptionMessage:
          type: string
          nullable: true
          description: >-
            Only select jobs that failed due to an exception with the given
            message.
        failedActivityId:
          type: string
          nullable: true
          description: >-
            Only select jobs that failed due to an exception at an activity with
            the given id.
        noRetriesLeft:
          type: boolean
          nullable: true
          description: >-
            Only select jobs which have no retries left. Value may only be
            `true`, as `false` is the

            default behavior.
        active:
          type: boolean
          nullable: true
          description: >-
            Only include active jobs. Value may only be `true`, as `false` is
            the default behavior.
        suspended:
          type: boolean
          nullable: true
          description: >-
            Only include suspended jobs. Value may only be `true`, as `false` is
            the default behavior.
        priorityLowerThanOrEquals:
          type: integer
          format: int64
          nullable: true
          description: >-
            Only include jobs with a priority lower than or equal to the given
            value. Value must be a

            valid `long` value.
        priorityHigherThanOrEquals:
          type: integer
          format: int64
          nullable: true
          description: >-
            Only include jobs with a priority higher than or equal to the given
            value. Value must be a

            valid `long` value.
        tenantIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: Only include jobs which belong to one of the passed  tenant ids.
        withoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Only include jobs which belong to no tenant. Value may only be
            `true`, as `false` is the

            default behavior.
        includeJobsWithoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Include jobs which belong to no tenant. Can be used in combination
            with `tenantIdIn`.

            Value may only be `true`, as `false` is the default behavior.
        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. Does not have an effect for the `count` endpoint.
          items:
            type: object
            properties:
              sortBy:
                type: string
                nullable: true
                enum:
                  - jobId
                  - executionId
                  - processInstanceId
                  - processDefinitionId
                  - processDefinitionKey
                  - jobPriority
                  - jobRetries
                  - jobDueDate
                  - 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.
    JobDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the job.
        jobDefinitionId:
          type: string
          nullable: true
          description: The id of the associated job definition.
        dueDate:
          type: string
          format: date-time
          nullable: true
          description: The date on which this job is supposed to be processed.
        processInstanceId:
          type: string
          nullable: true
          description: The id of the process instance which execution created the job.
        executionId:
          type: string
          nullable: true
          description: The specific execution id on which the job was created.
        processDefinitionId:
          type: string
          nullable: true
          description: The id of the process definition which this job belongs to.
        processDefinitionKey:
          type: string
          nullable: true
          description: The key of the process definition which this job belongs to.
        retries:
          type: integer
          format: int32
          nullable: true
          description: The number of retries this job has left.
        exceptionMessage:
          type: string
          nullable: true
          description: >-
            The message of the exception that occurred, the last time the job
            was executed. Is

            null when no exception occurred.
        failedActivityId:
          type: string
          nullable: true
          description: >-
            The id of the activity on which the last exception occurred, the
            last time the job

            was executed. Is null when no exception occurred.
        suspended:
          type: boolean
          nullable: true
          description: A flag indicating whether the job is suspended or not.
        priority:
          type: integer
          format: int64
          nullable: true
          description: The job's priority for execution.
        tenantId:
          type: string
          nullable: true
          description: The id of the tenant which this job belongs to.
        createTime:
          type: string
          format: date-time
          nullable: true
          description: The date on which this job has been created.
        batchId:
          type: string
          nullable: true
          description: >-
            The ID of the batch associated with this job. `null` if no batch is
            associated with this job. The

            following jobs are associated with batches:

            * Seed Jobs

            * Monitor Jobs

            * Batch Execution Jobs
    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).
    JobConditionQueryParameterDto:
      type: object
      properties:
        operator:
          type: string
          nullable: true
          enum:
            - gt
            - lt
          description: Comparison operator to be used.
        value:
          type: string
          format: date-time
          nullable: true
          description: Date value to compare with.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````