Skip to navigation

Get a request

Returns the details of a request, including its status and the service run it started.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

requestIdstringRequired

The request’s unique identifier (service_request_items._id), a UUIDv7.

Response

result
requestIdstring
serviceIdstring
serviceNamestring
requestedOnstring
lastUpdatedAtstring
statusenum
Allowed values:
requestTypeenum

Where the request came from: on_demand for one made on demand, schedule for one a schedule dispatched, endpoint for one made through an endpoint.

Allowed values:
inputobject
canRequestboolean
scheduleIdstringOptional

The schedule that dispatched the request. Present only when requestType is schedule. It stays after the schedule is deleted; see scheduleAccessible.

scheduleTypeenumOptional

How the schedule that dispatched the request ran, as it was when the request was made, so later edits and deletion of the schedule do not change it: recurring repeats on schedule; concrete fires once, at concreteDate. Present only when requestType is schedule, whether or not the current user may read the schedule. Absent on a scheduled request made before the timing was recorded.

Allowed values:
scheduleobjectOptional

How a recurring schedule repeats, and its start and end, in the same shape as the schedule search and detail. Set only when scheduleType is recurring. The response carries no text for it: a client words it.

concreteDatestringOptional

The instant a concrete schedule fires, ISO 8601 in UTC. Set only when scheduleType is concrete.

scheduleAccessiblebooleanOptional

Whether the schedule named by scheduleId still exists and the current user may read it, so a client can link to it only then. False both when the schedule was deleted and when the user cannot read it. Absent when it could not be determined, such as when the lookup failed: a client shows no link then. Only a request with requestType schedule can have it.

requestedByobjectOptional
runobjectOptional
externalViewUrlstringOptional
Whether either engine exposes this at all is unconfirmed.
pendingWorkItemobjectOptional
Present only on searchRequests rows with an actionable pending Work Center item.

Errors

500
Internal Server Error