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

# 通过key获取

> Retrieves the latest version of the process definition which belongs to no tenant according to the `ProcessDefinition` interface in the engine.



## OpenAPI

````yaml GET /process-definition/key/{key}
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/key/{key}:
    get:
      tags:
        - Process Definition
      summary: Get
      description: >-
        Retrieves the latest version of the process definition which belongs to
        no tenant according to the `ProcessDefinition` interface in the engine.
      operationId: getProcessDefinitionByKey
      parameters:
        - name: key
          in: path
          schema:
            type: string
          required: true
          description: >-
            The key of the process definition (the latest version thereof) to be
            retrieved.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessDefinitionDto'
              examples:
                example-1:
                  summary: Status 200 response
                  description: Response of GET `/process-definition/key/invoice`
                  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
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Process definition with given `key` does not exist. 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

````