API referenceCases
API reference
Get a study version
Have a token? Manage tokens in the console
GET
One saved version of a study.
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.
version*integerThe version number, from the version list.
Format
int32iohr.cases.v1.GetStudyVersionResponse
application/json- response
iohr.cases.v1.GetStudyVersionResponse
version?iohr.cases.v1.StudyVersion
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.getStudyVersion("<study_id>", "<version>"); 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
{ "version": { "note": "string", "saved_at": "string", "saved_by": "string", "study_id": "string", "text": { "en": { "markdown": "string", "summary": "string", "title": "string" }, "hr": { "markdown": "string", "summary": "string", "title": "string" } }, "version": 0 }}