SMsmokeball
Tasks

Get a task document

Retrieves the specified task document for the specified task.

get/tasks/{taskId}/documents/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/tasks/{taskId}/documents/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

taskIdstring uuid required
idstring uuid required

Response

When request is successful. Returns a 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
type0 | 1 | 2

Available document types: "File = 0", "FormTemplate = 1", "Memo = 2"

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

isDeletedboolean

True when the task document has been deleted.

documentunknown

Changes

No recorded changes to this operation across all 15 revisions of this API.