> ## 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 task by id.



## OpenAPI

````yaml GET /task/{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:
  /task/{id}:
    get:
      tags:
        - Task
      summary: Get
      description: Retrieves a task by id.
      operationId: getTask
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: The id of the task to be retrieved.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskWithAttachmentAndCommentDto'
              examples:
                example-1:
                  summary: GET /task/anId Response
                  value:
                    id: anId
                    name: aName
                    assignee: anAssignee
                    created: 2013-01-23T13:42:42.000+0200
                    due: 2013-01-23T13:49:42.576+0200
                    followUp: 2013-01-23T13:44:42.437+0200
                    delegationState: RESOLVED
                    description: aDescription
                    executionId: anExecution
                    owner: anOwner
                    parentTaskId: aParentId
                    priority: 42
                    processDefinitionId: aProcDefId
                    processInstanceId: aProcInstId
                    caseDefinitionId: aCaseDefId
                    caseInstanceId: aCaseInstId
                    caseExecutionId: aCaseExecution
                    taskDefinitionKey: aTaskDefinitionKey
                    suspended: false
                    formKey: aFormKey
                    camundaFormRef:
                      key: aCamundaFormKey
                      binding: version
                      version: 2
                    tenantId: aTenantId
                    taskState: aTaskState
                example-2:
                  summary: GET /task/anId?withCommentAttachmentInfo=true Response
                  value:
                    - id: 349fffa8-6571-11e7-9a44-d6940f5ef88d
                      name: Approve Invoice
                      assignee: John Munda
                      created: 2017-07-10T15:10:54.670+0200
                      due: 2017-07-17T15:10:54.670+0200
                      followUp: null
                      lastUpdated: 2017-07-17T15:10:54.670+0200
                      delegationState: null
                      description: Approve the invoice (or not).
                      executionId: 349f8a5c-6571-11e7-9a44-d6940f5ef88d
                      owner: null
                      parentTaskId: null
                      priority: 50
                      processDefinitionId: invoice:1:2c8d8057-6571-11e7-9a44-d6940f5ef88d
                      processInstanceId: 349f8a5c-6571-11e7-9a44-d6940f5ef88d
                      taskDefinitionKey: approveInvoice
                      caseExecutionId: null
                      caseInstanceId: null
                      caseDefinitionId: null
                      suspended: false
                      formKey: embedded:app:develop/invoice-forms/approve-invoice.html
                      tenantId: null
                      taskState: aTaskState
                      attachment: false
                      comment: false
          description: Request successful.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Task 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:
    TaskWithAttachmentAndCommentDto:
      allOf:
        - type: object
          properties:
            attachment:
              type: boolean
              nullable: true
              description: Specifies if an attachment exists for the task.
            comment:
              type: boolean
              nullable: true
              description: Specifies if an comment exists for the task.
        - $ref: '#/components/schemas/TaskDto'
    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).
    TaskDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The task id.
        name:
          type: string
          nullable: true
          description: The task name.
        assignee:
          type: string
          nullable: true
          description: The assignee's id.
        owner:
          type: string
          nullable: true
          description: The owner's id.
        created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date the task was created on.

            [Default
            format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        lastUpdated:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date the task was last updated. Every action that fires a [task
            update
            event](https://docs.camunda.org/manual/7.22/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle)
            will update this property.

            [Default
            format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        due:
          type: string
          format: date-time
          nullable: true
          description: >-
            The task's due date.

            [Default
            format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        followUp:
          type: string
          format: date-time
          nullable: true
          description: >-
            The follow-up date for the task.

            [Default
            format](https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

            `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        delegationState:
          type: string
          nullable: true
          enum:
            - PENDING
            - RESOLVED
          description: >-
            The task's delegation state. Possible values are `PENDING` and
            `RESOLVED`.
        description:
          type: string
          nullable: true
          description: The task's description.
        executionId:
          type: string
          nullable: true
          description: The id of the execution the task belongs to.
        parentTaskId:
          type: string
          nullable: true
          description: The id the parent task, if this task is a subtask.
        priority:
          type: integer
          format: int32
          nullable: true
          description: The task's priority.
        processDefinitionId:
          type: string
          nullable: true
          description: The id of the process definition the task belongs to.
        processInstanceId:
          type: string
          nullable: true
          description: The id of the process instance the task belongs to.
        caseExecutionId:
          type: string
          nullable: true
          description: The id of the case execution the task belongs to.
        caseDefinitionId:
          type: string
          nullable: true
          description: The id of the case definition the task belongs to.
        caseInstanceId:
          type: string
          nullable: true
          description: The id of the case instance the task belongs to.
        taskDefinitionKey:
          type: string
          nullable: true
          description: The task's key.
        suspended:
          type: boolean
          nullable: true
          description: Whether the task belongs to a process instance that is suspended.
        formKey:
          type: string
          nullable: true
          description: If not `null`, the form key for the task.
        camundaFormRef:
          $ref: '#/components/schemas/CamundaFormRef'
        tenantId:
          type: string
          nullable: true
          description: If not `null`, the tenant id of the task.
        taskState:
          type: string
          nullable: true
          description: The task's state.
    CamundaFormRef:
      type: object
      properties:
        key:
          type: string
          nullable: true
          description: The key of the Camunda Form.
        binding:
          type: string
          nullable: true
          description: >-
            The binding of the Camunda Form. Can be `latest`, `deployment` or
            `version`.
        version:
          type: integer
          format: int32
          nullable: true
          description: >-
            The specific version of a Camunda Form. This property is only set if
            `binding` is `version`.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````