Task programs: assign, claim, complete, delegate

Reference for Task, one group of Task programs.

Task.assign

Assign gives a Task to a Worker, human or agent, and places it in that Worker’s worklist. Verb page.

Text

do: return await $.Task.assign(input)

Emits Task.assigned.

Inputs

Input	Type	Required	Description
`task`	Task	required	The Task to assign.
`worker`	Worker	required	The Worker who takes it.

Returns

Output	Type	Required	Description
`task`	Task	required	The assigned Task.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Task.assign({ task: 'task_tVPKjporKn', worker: 'worker_whZFpOKWIV' })"
  }
}

Task.claim

Claim takes an offered Task from a shared queue or a handoff and makes the calling Worker its assignee. Verb page.

Text

do: return await $.Task.claim(input)

Emits Task.claimed.

Inputs

Input	Type	Required	Description
`task`	Task	required	The offered Task.

Returns

Output	Type	Required	Description
`task`	Task	required	The Task, assigned to the caller.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Task.claim({ task: 'task_tVPKjporKn' })"
  }
}

Task.complete

Complete marks a Task done and resumes the Action that waited on it. Verb page.

Text

do: return await $.Task.complete(input)

Emits Task.completed.

Inputs

Input	Type	Required	Description
`task`	Task	required	The assigned Task.
`result`	`json`		What the Worker produced.

Returns

Output	Type	Required	Description
`task`	Task	required	The completed Task.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	None.
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Task.complete({ task: 'task_tVPKjporKn' })"
  }
}

Task.delegate

Delegate passes a Task to another Role along a declared handoff and keeps its history. Verb page.

Text

do: return await $.Task.delegate(input)

Emits Task.delegated.

Inputs

Input	Type	Required	Description
`task`	Task	required	The Task to pass on.
`role`	Role	required	The Role that receives it.

Returns

Output	Type	Required	Description
`task`	Task	required	The Task, held by the new Role.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Task.delegate({ task: 'task_tVPKjporKn', role: 'role_oloMFMUeCH' })"
  }
}

Task.assignCopy Anchor Link

Task.claimCopy Anchor Link

Task.completeCopy Anchor Link

Task.delegateCopy Anchor Link

Task.assign

Task.claim

Task.complete

Task.delegate