Vehicles
Create a vehicle
Registers a vehicle in the fleet.
vehicles:writeResult
generated from the schema
collectionId must be the UUID of an existing collection; tags go by name and one that does not exist is CREATED. Returns the created vehicle.
Arguments
Vehicle name.
Limits: min length 2, max length 200
Registration number.
Limits: max length 30
Vehicle description or notes.
Limits: max length 2000
Collection it belongs to.
Limits: min length 1
Number of seats.
Limits: min 0
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
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique vehicle identifier.
Vehicle name.
Operational status: active (available), maintenance (in the workshop) or inactive (out of service).
Available options: active, maintenance, inactive
Registration number; null if not recorded.
Seats, including the driver seat; null if not recorded.
Payload in kilograms; null if not recorded.
Date of the next technical inspection in ISO 8601 UTC; null if not recorded.
Identifier of the collection it belongs to; null if it is in none.
Collection path; null if not applicable.
true if it appears in the planner of the account.
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
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/vehicles.
Related pages
Link to this section: Related pagesVehicles
Create a vehicle
Registers a vehicle in the fleet.
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?