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



## OpenAPI

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

        more powerful than the

        [Get Job
        Definitions](https://docs.camunda.org/manual/7.22/reference/rest/job-definition/get-query/)

        method because it allows filtering by multiple job definitions of

        types `String`, `Number` or `Boolean`.
      operationId: queryJobDefinitions
      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/JobDefinitionQueryDto'
            examples:
              example-1:
                summary: POST `/job-definition`
                value:
                  activityIdIn:
                    - ServiceTask1
                    - ServiceTask2
                  sorting:
                    - sortBy: activityId
                      sortOrder: asc
                    - sortBy: jobType
                      sortOrder: asc
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JobDefinitionDto'
              examples:
                example-1:
                  summary: POST `/job-definition`
                  description: POST `/job-definition`
                  value:
                    - id: aJobDefId
                      processDefinitionId: aProcDefId
                      processDefinitionKey: aProcDefKey
                      activityId: ServiceTask1
                      jobType: asynchronous-continuation
                      jobConfiguration: ''
                      suspended: false
                      overridingJobPriority: 15
                      tenantId: null
                      deploymentId: aDeploymentId
                    - id: aJobDefId
                      processDefinitionId: aProcDefId
                      processDefinitionKey: aProcDefKey
                      activityId: ServiceTask2
                      jobType: asynchronous-continuation
                      jobConfiguration: ''
                      suspended: true
                      overridingJobPriority: null
                      tenantId: null
                      deploymentId: aDeploymentId
          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:
    JobDefinitionQueryDto:
      type: object
      description: A Job definition query which defines a list of Job definitions
      properties:
        jobDefinitionId:
          type: string
          nullable: true
          description: Filter by job definition id.
        activityIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Only include job definitions which belong to one of the passed
            activity ids.
        processDefinitionId:
          type: string
          nullable: true
          description: >-
            Only include job definitions which exist for the given process
            definition id.
        processDefinitionKey:
          type: string
          nullable: true
          description: >-
            Only include job definitions which exist for the given process
            definition key.
        jobType:
          type: string
          nullable: true
          description: >-
            Only include job definitions which exist for the given job type. See
            the

            [User
            Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/the-job-executor/#job-creation)

            for more information about job types.
        jobConfiguration:
          type: string
          nullable: true
          description: >-
            Only include job definitions which exist for the given job
            configuration. For example: for

            timer jobs it is the timer configuration.
        active:
          type: boolean
          nullable: true
          description: >-
            Only include active job definitions. Value may only be `true`, as
            `false` is the default

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

            default behavior.
        withOverridingJobPriority:
          type: boolean
          nullable: true
          description: >-
            Only include job definitions that have an overriding job priority
            defined. The only

            effective value is `true`. If set to `false`, this filter is not
            applied.
        tenantIdIn:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Only include job definitions which belong to one of the passed
            tenant

            ids.
        withoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Only include job definitions which belong to no tenant. Value may
            only be `true`, as

            `false` is the default behavior.
        includeJobDefinitionsWithoutTenantId:
          type: boolean
          nullable: true
          description: >-
            Include job definitions 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. Sorting has no effect for `count` endpoints.
          items:
            type: object
            properties:
              sortBy:
                type: string
                nullable: true
                enum:
                  - jobDefinitionId
                  - activityId
                  - processDefinitionId
                  - processDefinitionKey
                  - jobType
                  - jobConfiguration
                  - 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.
    JobDefinitionDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the job definition.
        processDefinitionId:
          type: string
          nullable: true
          description: >-
            The id of the process definition this job definition is associated
            with.
        processDefinitionKey:
          type: string
          nullable: true
          description: >-
            The key of the process definition this job definition is associated
            with.
        activityId:
          type: string
          nullable: true
          description: The id of the activity this job definition is associated with.
        jobType:
          type: string
          nullable: true
          description: >-
            The type of the job which is running for this job definition. See
            the

            [User
            Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/the-job-executor/#job-creation)

            for more information about job types.
        jobConfiguration:
          type: string
          nullable: true
          description: >-
            The configuration of a job definition provides details about the
            jobs which will be

            created. For example: for timer jobs it is the timer configuration.
        overridingJobPriority:
          type: integer
          format: int64
          nullable: true
          description: >-
            The execution priority defined for jobs that are created based on
            this definition.

            May be `null` when the priority has not been overridden on the job

            definition level.
        suspended:
          type: boolean
          nullable: true
          description: Indicates whether this job definition is suspended or not.
        tenantId:
          type: string
          nullable: true
          description: The id of the tenant this job definition is associated with.
        deploymentId:
          type: string
          nullable: true
          description: >-
            The id of the deployment this job definition is related to. In a
            deployment-aware

            setup, this leads to all jobs of the same definition being executed

            on the same node.
    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

````