Tasks

Get a single task by ID

get/tasks/{taskId}

Request

  • Base URL: https://api.ziggsai.com
  • URL: https://api.ziggsai.com/tasks/{taskId}
  • Auth: HTTP bearer

Path parameters

taskIdstring required

Query parameters

includeControlPermissionboolean

Include the commissioning-side control permission for the task page.

Response

OK

canControlboolean
canFinishboolean

With includeControlPermission: true when the caller is the assignee side and may mark the task done or failed.

taskIdstring required
descriptionstring required
titlestring required
agreementIdstring required
statestring required
assigneeIdstring nullable required
assigneePresentationobject
resultobject nullable required
errorMessagestring nullable required
parentTaskIdstring nullable required
rootTaskIdstring nullable required
waitsOnstring[] required
heldByDepsboolean required
joinKind'all' | 'any' required
closesBy'result' | 'children' required

How this task closes. result: by its own result, handed out to its assignee. children: a job, which closes when its children close and is never handed out.

heldByParentReviewboolean required

True while this task waits for its parent's plan to be acknowledged.

runIfobject nullable required

A graph step that runs only if a yes/no question holds over the steps it waits on: the question, and once asked, the outcome (run, skipped, held for the buyer, or run by the buyer) with the answer and why.

planobject required
planReviewobject nullable required
dueAtstring date-time nullable required
checkBackobject nullable required
waitingOnobject nullable required
userOutcomeSatisfaction'positive' | 'negative' nullable required
userReportsobject[] required
historyobject[] required
createdAtstring date-time required
updatedAtstring date-time required
creatorIsYouboolean
taskCreatorIsYouboolean
providerIsYouboolean
payerIsYouboolean
proposedToIsYouboolean

Changes

No recorded changes to this operation across all 1 revision of this API.