Sign in
Docs
API referenceSchedules

API reference

Who covers

Have a token? Manage tokens in the console
GET
/v1/schedules/{schedule_id}/coverage

Who covers a schedule at an instant, from an override, a layer or the default, with the span and its scope. Name a responder and a kind (merge, roll, migration or ask) to learn whether they may act on it then, and why.

Needs scope schedules:read.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

schedule_id*string

The schedule.

Query Parameters

account_id?string

A team you belong to; empty for your own account.

at?string

An RFC 3339 time; empty is now.

responder.kind?string
responder.id?string
kind?string

merge, roll, migration or ask, with a responder.

Response Body

iohr.schedules.v1.WhoCoversResponse

application/json
  1. response

iohr.schedules.v1.WhoCoversResponse

allowed*boolean
at*string
coverage?

iohr.schedules.v1.Coverage

why*string
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.schedules.whoCovers("<schedule_id>");  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "allowed": true,  "at": "string",  "coverage": {    "end": "string",    "layer_id": "string",    "override_id": "string",    "responder": {      "id": "string",      "kind": "string"    },    "scope": [      "string"    ],    "source": "string",    "start": "string"  },  "why": "string"}