Planner
Remove a resource from a service
Undoes an assignment.
planner:writeplanner:write- 120/min
- Server annotation: Destructive
- Requires human confirmation
Result
generated from the schema
Requires human confirmation
Put this tool on your client's “ask before running” list. The annotations are hints that the server declares, not guarantees: do not decide the approval from destructiveHint alone.
It is a POST to a sub-resource and not a DELETE because the target is identified with up to four fields and the resource with three (assignmentId, staffId or vehicleId): that does not fit in a path, and a DELETE with a required body is a worse contract. On a task the resource is always staffId: a task has neither vehicles nor assignment identifiers, and sending one of those responds 400 validation_error on that field. A target that does not exist or belongs to another account also responds 400 validation_error, with errors[]. on its field; a resource that is not assigned to that target responds 404 not_found: there is nothing to remove.
Arguments
Order the service is attached to.
Service line within that order.
Schedule task to remove the resource from.
Internal assignment to remove it from.
Identifier of the specific assignment, if you have it.
Staff member being removed.
Vehicle being removed.
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Operation result.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs POST /api/v1/planner/assignments/remove.
Related pages
Link to this section: Related pagesPlanner
Remove a resource from a service
Undoes an assignment.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?