Internal services
Create an internal service
Schedules a working day that does not hang off an order: maintenance, transfer between warehouses, training.
internal-services:writeResult
generated from the schema
The MINIMUM duration is fifteen minutes. Returns the created internal service.
Arguments
Assignment title.
Limits: min length 1
Description of what needs to be done.
Catalogue service it comes from, if it comes from one.
Assignment type. Defaults to "crew".
Available options: crew, fleet, general
Start in ISO 8601 with offset.
End in ISO 8601 with offset. At least fifteen minutes after the start.
Project it is charged to.
Assigned staff.
Assigned vehicles.
How many units of the service.
Limits: min 1
Resources needed to provide it.
Show child attributesHide child attributes
What is needed: personnel or vehicle.
Available options: personnel, vehicle
How many are needed.
Limits: min 1
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 assignment identifier.
Assignment title.
Status: active, completed or cancelled.
Start in ISO 8601 UTC.
End in ISO 8601 UTC.
Associated project; null if not applicable.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
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/internal-services.
Related pages
Link to this section: Related pagesInternal services
Create an internal service
Schedules a working day that does not hang off an order: maintenance, transfer between warehouses, training.
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?