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

# 根据Id获取

> Retrieves a historic process instance by id, according to the `HistoricProcessInstance` interface in the engine.



## OpenAPI

````yaml GET /history/process-instance/{id}
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:
  /history/process-instance/{id}:
    get:
      tags:
        - Historic Process Instance
      summary: Get
      description: >-
        Retrieves a historic process instance by id, according to the
        `HistoricProcessInstance` interface in the engine.
      operationId: getHistoricProcessInstance
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: The id of the historic process instance to be retrieved.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricProcessInstanceDto'
              examples:
                example-1:
                  summary: >-
                    GET
                    `/history/process-instance/7c80cc8f-ef95-11e6-b6e6-34f39ab71d4e`
                  value:
                    id: 7c80cc8f-ef95-11e6-b6e6-34f39ab71d4e
                    businessKey: null
                    processDefinitionId: invoice:1:7bf79f13-ef95-11e6-b6e6-34f39ab71d4e
                    processDefinitionKey: invoice
                    processDefinitionName: Invoice Receipt
                    processDefinitionVersion: 1
                    startTime: 2017-02-10T14:33:19.000+0200
                    endTime: null
                    removalTime: null
                    durationInMillis: null
                    startUserId: null
                    startActivityId: StartEvent_1
                    deleteReason: null
                    rootProcessInstanceId: f8259e5d-ab9d-11e8-8449-e4a7a094a9d6
                    superProcessInstanceId: null
                    superCaseInstanceId: null
                    caseInstanceId: null
                    tenantId: null
                    state: ACTIVE
                    restartedProcessInstanceId: 2bef365d-3406-11ef-bd73-0a0027000003
          description: Request successful.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Not Found

            Historic process instance with given id 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:
    HistoricProcessInstanceDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the process instance.
        rootProcessInstanceId:
          type: string
          nullable: true
          description: >-
            The process instance id of the root process instance that initiated
            the process.
        superProcessInstanceId:
          type: string
          nullable: true
          description: The id of the parent process instance, if it exists.
        superCaseInstanceId:
          type: string
          nullable: true
          description: The id of the parent case instance, if it exists.
        caseInstanceId:
          type: string
          nullable: true
          description: The id of the parent case instance, if it exists.
        processDefinitionName:
          type: string
          nullable: true
          description: >-
            The name of the process definition that this process instance
            belongs to.
        processDefinitionKey:
          type: string
          nullable: true
          description: >-
            The key of the process definition that this process instance belongs
            to.
        processDefinitionVersion:
          type: integer
          format: int32
          nullable: true
          description: >-
            The version of the process definition that this process instance
            belongs to.
        processDefinitionId:
          type: string
          nullable: true
          description: >-
            The id of the process definition that this process instance belongs
            to.
        businessKey:
          type: string
          nullable: true
          description: The business key of the process instance.
        startTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time the instance was started. Default
            [format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)
            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        endTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time the instance ended. Default
            [format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)
            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        removalTime:
          type: string
          format: date-time
          nullable: true
          description: >-
            The time after which the instance should be removed by the History
            Cleanup job. Default
            [format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)
            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        durationInMillis:
          type: integer
          format: int64
          nullable: true
          description: The time the instance took to finish (in milliseconds).
        startUserId:
          type: string
          nullable: true
          description: The id of the user who started the process instance.
        startActivityId:
          type: string
          nullable: true
          description: >-
            The id of the initial activity that was executed (e.g., a start
            event).
        deleteReason:
          type: string
          nullable: true
          description: >-
            The provided delete reason in case the process instance was canceled
            during execution.
        tenantId:
          type: string
          nullable: true
          description: The tenant id of the process instance.
        state:
          type: string
          nullable: true
          enum:
            - ACTIVE
            - SUSPENDED
            - COMPLETED
            - EXTERNALLY_TERMINATED
            - INTERNALLY_TERMINATED
          description: >-
            Last state of the process instance, possible values are:


            `ACTIVE` - running process instance


            `SUSPENDED` - suspended process instances


            `COMPLETED` - completed through normal end event


            `EXTERNALLY_TERMINATED` - terminated externally, for instance
            through REST API


            `INTERNALLY_TERMINATED` - terminated internally, for instance by
            terminating boundary event
        restartedProcessInstanceId:
          type: string
          nullable: true
          description: The id of the original process instance which was restarted.
    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

````