> ## 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 process definitions that fulfill given parameters. Parameters may be the properties of 
process definitions, such as the name, key or version. The size of the result set can be retrieved
by using the [Get Definition Count](https://docs.camunda.org/manual/7.22/reference/rest/process-definition/get-query-count/) method.



## OpenAPI

````yaml GET /process-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:
  /process-definition:
    get:
      tags:
        - Process Definition
      summary: Get List
      description: >-
        Queries for process definitions that fulfill given parameters.
        Parameters may be the properties of 

        process definitions, such as the name, key or version. The size of the
        result set can be retrieved

        by using the [Get Definition
        Count](https://docs.camunda.org/manual/7.22/reference/rest/process-definition/get-query-count/)
        method.
      operationId: getProcessDefinitions
      parameters:
        - name: processDefinitionId
          in: query
          schema:
            type: string
          description: Filter by process definition id.
        - name: processDefinitionIdIn
          in: query
          schema:
            type: string
          description: Filter by a comma-separated list of process definition ids.
        - name: name
          in: query
          schema:
            type: string
          description: Filter by process definition name.
        - name: nameLike
          in: query
          schema:
            type: string
          description: >-
            Filter by process definition names that the parameter is a substring
            of.
        - name: deploymentId
          in: query
          schema:
            type: string
          description: Filter by the deployment the id belongs to.
        - name: deployedAfter
          in: query
          schema:
            type: string
            format: date-time
          description: >-
            Filter by the deploy time of the deployment the process definition
            belongs to.

            Only selects process definitions that have been deployed after
            (exclusive) a specific time.

            By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),
            the date must have the

            format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,

            `2013-01-23T14:42:45.546+0200`.
        - name: deployedAt
          in: query
          schema:
            type: string
            format: date-time
          description: >-
            Filter by the deploy time of the deployment the process definition
            belongs to.

            Only selects process definitions that have been deployed at a
            specific time (exact match).

            By
            [default](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/),
            the date must have the

            format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,

            `2013-01-23T14:42:45.546+0200`.
        - name: key
          in: query
          schema:
            type: string
          description: >-
            Filter by process definition key, i.e., the id in the BPMN 2.0 XML.
            Exact match.
        - name: keysIn
          in: query
          schema:
            type: string
          description: Filter by a comma-separated list of process definition keys.
        - name: keyLike
          in: query
          schema:
            type: string
          description: >-
            Filter by process definition keys that the parameter is a substring
            of.
        - name: category
          in: query
          schema:
            type: string
          description: Filter by process definition category. Exact match.
        - name: categoryLike
          in: query
          schema:
            type: string
          description: >-
            Filter by process definition categories that the parameter is a
            substring of.
        - name: version
          in: query
          schema:
            type: integer
            format: int32
          description: Filter by process definition version.
        - name: latestVersion
          in: query
          schema:
            type: boolean
          description: |-
            Only include those process definitions that are latest versions.
            Value may only be `true`, as `false` is the default behavior.
        - name: resourceName
          in: query
          schema:
            type: string
          description: Filter by the name of the process definition resource. Exact match.
        - name: resourceNameLike
          in: query
          schema:
            type: string
          description: >-
            Filter by names of those process definition resources that the
            parameter is a substring of.
        - name: startableBy
          in: query
          schema:
            type: string
          description: Filter by a user name who is allowed to start the process.
        - name: active
          in: query
          schema:
            type: boolean
          description: |-
            Only include active process definitions.
            Value may only be `true`, as `false` is the default behavior.
        - name: suspended
          in: query
          schema:
            type: boolean
          description: |-
            Only include suspended process definitions.
            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](https://docs.camunda.org/manual/7.22/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.
            A process definition must have one of the given tenant ids.
        - name: withoutTenantId
          in: query
          schema:
            type: boolean
          description: |-
            Only include process definitions which belong to no tenant.
            Value may only be true, as false is the default behavior.
        - name: includeProcessDefinitionsWithoutTenantId
          in: query
          schema:
            type: boolean
          description: >-
            Include process definitions which belong to no tenant. Can be used
            in combination with `tenantIdIn`.

            Value may only be `true`, as `false` is the default behavior.
        - name: versionTag
          in: query
          schema:
            type: string
          description: Filter by the version tag.
        - name: versionTagLike
          in: query
          schema:
            type: string
          description: Filter by the version tag that the parameter is a substring of.
        - name: withoutVersionTag
          in: query
          schema:
            type: boolean
          description: Only include process definitions without a `versionTag`.
        - name: startableInTasklist
          in: query
          schema:
            type: boolean
          description: Filter by process definitions which are startable in Tasklist..
        - name: notStartableInTasklist
          in: query
          schema:
            type: boolean
          description: Filter by process definitions which are not startable in Tasklist.
        - name: startablePermissionCheck
          in: query
          schema:
            type: boolean
          description: >-
            Filter by process definitions which the user is allowed to start in
            Tasklist.

            If the user doesn't have these permissions the result will be empty
            list.

            The permissions are:

            * `CREATE` permission for all Process instances

            * `CREATE_INSTANCE` and `READ` permission on Process definition
            level
        - name: sortBy
          in: query
          schema:
            enum:
              - category
              - key
              - id
              - name
              - version
              - deploymentId
              - deployTime
              - 'tenantId '
              - versionTag
            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/ProcessDefinitionDto'
              examples:
                example-1:
                  summary: Status 200 response
                  description: >-
                    Response of GET
                    `/process-definition?keyLike=invoice&sortBy=version&sortOrder=asc`
                  value:
                    - id: invoice:1:c3a63aaa-2046-11e7-8f94-34f39ab71d4e
                      key: invoice
                      category: http://www.omg.org/spec/BPMN/20100524/MODEL
                      description: null
                      name: Invoice Receipt
                      version: 1
                      resource: invoice.v1.bpmn
                      deploymentId: c398cd26-2046-11e7-8f94-34f39ab71d4e
                      diagram: null
                      suspended: false
                      tenantId: null
                      versionTag: null
                      historyTimeToLive: 5
                      startableInTasklist: true
                    - id: invoice:2:c3e1bd16-2046-11e7-8f94-34f39ab71d4e
                      key: invoice
                      category: http://www.omg.org/spec/BPMN/20100524/MODEL
                      description: null
                      name: Invoice Receipt
                      version: 2
                      resource: invoice.v2.bpmn
                      deploymentId: c3d82020-2046-11e7-8f94-34f39ab71d4e
                      diagram: null
                      suspended: false
                      tenantId: null
                      versionTag: null
                      historyTimeToLive: null
                      startableInTasklist: 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:
    ProcessDefinitionDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the process definition
        key:
          type: string
          nullable: true
          description: >-
            The key of the process definition, i.e., the id of the BPMN 2.0 XML
            process definition.
        category:
          type: string
          nullable: true
          description: The category of the process definition.
        description:
          type: string
          nullable: true
          description: The description of the process definition.
        name:
          type: string
          nullable: true
          description: The name of the process definition.
        version:
          type: integer
          format: int32
          nullable: true
          description: >-
            The version of the process definition that the engine assigned to
            it.
        resource:
          type: string
          nullable: true
          description: The file name of the process definition.
        deploymentId:
          type: string
          nullable: true
          description: The deployment id of the process definition.
        diagram:
          type: string
          nullable: true
          description: The file name of the process definition diagram, if it exists.
        suspended:
          type: boolean
          nullable: true
          description: A flag indicating whether the definition is suspended or not.
        tenantId:
          type: string
          nullable: true
          description: The tenant id of the process definition.
        versionTag:
          type: string
          nullable: true
          description: The version tag of the process definition.
        historyTimeToLive:
          type: integer
          format: int32
          nullable: true
          minimum: 0
          description: >-
            History time to live value of the process definition.

            Is used within [History
            cleanup](https://docs.camunda.org/manual/7.22/user-guide/process-engine/history/#history-cleanup).
        startableInTasklist:
          type: boolean
          nullable: true
          description: >-
            A flag indicating whether the process definition is startable in
            Tasklist or not.
    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

````