Services
Get a service
Returns a sellable service by its identifier: type, default quantity, whether it is included in the document price and which resources are needed to provide it.
services:readservices:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
It does NOT emit its cost or the internal name.
Arguments
Service identifier.
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 service identifier.
Service name as the customer sees it.
Type: crew (personnel), fleet (vehicles) or general.
Description; null if it has none.
Quantity added to an order by default.
Whether it appears as a plannable service.
Whether its amount counts towards the document total.
Path of the collection it belongs to; null if it is in none.
Resources needed to provide it.
Show child attributesHide child attributes
What is needed to provide it: personnel or vehicle.
Available options: personnel, vehicle
How many are needed.
Limits: min 1
Tags the assigned resource must have. E.g.: "Carné C".
Limits: max 20 items, each max length 100
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 GET /api/v1/services/{serviceId}.
Related pages
Link to this section: Related pagesServices
Get a service
Returns a sellable service by its identifier: type, default quantity, whether it is included in the document price and which resources are needed to provide it.
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?