Camunda Platform 7.13

Options

Edit on Github

Get Task Attachments

Gets the attachments for a task.

Method

GET /task/{id}/attachment

Parameters

Path Parameters

Name Description
id The id of the task to retrieve the attachments for.

Result

A JSON object containing a list of task attachments.

Name Value Description
id String The id of the task attachment.
name String The name of the task attachment.
taskId String The id of the task to which the attachment belongs.
description String The description of the task attachment.
type String Indication of the type of content that this attachment refers to. Can be MIME type or any other indication.
url String The url to the remote content of the task attachment.
createTime String The time the variable was inserted. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
removalTime String The time after which the attachment should be removed by the History Cleanup job. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
rootProcessInstanceId String The process instance id of the root process instance that initiated the process containing the task.

* For further information, please see the documentation.

Response Codes

Code Media type Description
200 application/json Request successful.
404 application/json No task exists for the given task id. See the Introduction for the error response format.

Example

Request

GET /task/aTaskId/attachment

Response

[
  {
    "id": "attachmentId",
    "name": "attachmentName",
    "taskId": "aTaskId",
    "description": "attachmentDescription",
    "type": "attachmentType",
    "url": "http://my-attachment-content-url.de",
    "createTime":"2017-02-10T14:33:19.000+0200",
    "removalTime":"2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  },
  {
    "id": "anotherAttachmentId",
    "name": "anotherAttachmentName",
    "taskId": "aTaskId",
    "description": "anotherAttachmentDescription",
    "type": "anotherAttachmentType",
    "url": "http://my-another-attachment-content-url.de",
    "createTime":"2017-02-10T14:33:19.000+0200",
    "removalTime":"2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  },
  {
    "id": "yetAnotherAttachmentId",
    "name": "yetAnotherAttachmentName",
    "taskId": "aTaskId",
    "description": "yetAnotherAttachmentDescription",
    "type": "yetAnotherAttachmentType",
    "url": "http://yet-another-attachment-content-url.de",
    "createTime":"2017-02-10T14:33:19.000+0200",
    "removalTime":"2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  }
]

On this Page: