API referenceCases
API reference
Get a study's lessons
Have a token? Manage tokens in the console
GET
The lessons drafted for a study, labelled Draft, not approved until approved.
Needs scope cases:read.
bearerheader
AuthorizationBearer <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, stu_ and 32 hex characters, from List studies.
iohr.cases.v1.GetLessonsResponse
application/json- response
iohr.cases.v1.GetLessonsResponse
lessons?iohr.cases.v1.Lessons
SDK
HTTP
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.getLessons("<study_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
{ "lessons": { "approved_at": "string", "approved_by": "string", "approved_version": 0, "drafted_at": "string", "drafted_by": "string", "label": "string", "lessons": [ { "correction_id": "string", "evidence": [ "string" ], "text": "string" } ], "markdown": "string", "state": "string", "study_id": "string" }}