SMsmokeball
Tasks

Get a subtask

Retrieves a specified subtask.

get/tasks/{taskId}/subtasks/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/tasks/{taskId}/subtasks/{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 'SubTask' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
subjectstring nullable

The subject - a short description of the subtask.

completedDatestring date-time nullable

Deprecated. Use CompletedDateOnly instead.

When the subtask was completed in UTC.

completedDateOnlystring date-time nullable

The date when the subtask was completed.

The time portion will always be set to 00:00:00 and should be ignored. Only the date portion is relevant.

createdDatestring date-time nullable

Deprecated. Use CreatedDateOnly instead.

When the subtask was created in UTC.

createdDateOnlystring date-time nullable

The date when the subtask was created.

The time portion will always be set to 00:00:00 and should be ignored. Only the date portion is relevant.

isCompletedboolean

True when the subtask is completed.

isDeletedboolean

True when the subtask is deleted.

lastUpdatedinteger

Last updated timestamp.

Example response

{
  "subject": "Confer with Mary",
  "completedDate": "2020-02-15T13:00:00Z",
  "completedDateOnly": "2020-02-15T00:00:00",
  "createdDate": "2020-02-15T13:00:00Z",
  "createdDateOnly": "2020-02-15T00:00:00",
  "lastUpdated": 637847425252027400
}

Changes

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