Create a task document

Links the specified document to the specified task.

POST /tasks/{taskId}/documents

Create a task document

cURL

curl --request POST \
  --url https://api.smokeball.com/tasks/{taskId}/documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": 0,
  "documentId": "cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277"
}
'

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

taskId · string<uuid> · required

Body

application/json-patch+jsonapplication/jsonapplication/*+json

Data transfer object for a task document.

type · enum<integer> · required

The type of the document.

Possible values: File = 0, FormTemplate = 1, Memo = 2.

The FormTemplate (1) document type is not currently supported for task document creation.

Available options: 0, 1, 2

Example:

0

documentId · string | null

Unique identifier of the document (file or memo).

If a file, the type must be 0 (File).

If a memo, the type must be 2 (Memo).

The FormTemplate (1) document type is not currently supported for task document creation.

Example:

"cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277"

Response

202

application/json

When request is accepted. Returns a hypermedia 'Link' object of the link to be created.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET