API reference
Get the plan behind a case
The items and timeline of the plan a study or client case follows, read from the Planner. A study sees everything; a client case only the items marked shareable, with no job, host or agent names. If the Planner cannot be read, plan_unavailable is true and the text still reads. An item resting on a stub fact is shown unconfirmed, never done.
Needs scope cases:read.
bearerAuthorizationBearer <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.
study_id?stringThe study's id, from List studies. Give this or case_id.
case_id?stringThe client case's id, cas_ and 32 hex characters, from List client cases.
iohr.cases.v1.GetCasePlanResponse
application/json- response
iohr.cases.v1.GetCasePlanResponse
items*array<>plan_id*stringplan_unavailable*booleantimeline*array<>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.cases.getCasePlan(); 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.
{ "items": [ { "brief": "string", "plan": { "reason": "string", "ref": "string", "stage": "string", "status": "string", "stub": true }, "proof_links": [ "string" ], "public_title": "string", "shareable": true } ], "plan_id": "string", "plan_unavailable": true, "timeline": [ { "actor": "string", "at": "string", "from_stage": "string", "job_id": "string", "kind": "string", "outcome": "string", "to_stage": "string" } ]}