Internal services
Get an internal service
Returns a scheduled internal service that does not hang off an order: its title, its window and the project it is charged to.
internal-services:readinternal-services:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Arguments
Internal 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 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 GET /api/v1/internal-services/{internalServiceId}.
Related pages
Link to this section: Related pagesInternal services
Get an internal service
Returns a scheduled internal service that does not hang off an order: its title, its window and the project it is charged to.
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?