Sign in
Docs
API referenceCases

API reference

List study versions

Have a token? Manage tokens in the console
GET
/v1/cases/studies/{study_id}/versions

Every saved version of a study, newest first, a page at a time.

Needs scope cases: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

study_id*string

The study's id, stu_ and 32 hex characters, from List studies.

Query Parameters

page_size?integer

At most this many; 0 means 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

Response Body

iohr.cases.v1.ListStudyVersionsResponse

application/json
  1. response

iohr.cases.v1.ListStudyVersionsResponse

next_page_token*string
versions*array<>
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  for await (const studyVersion of api.cases.allListStudyVersions("<study_id>")) {    console.log(studyVersion);  }} 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
{  "next_page_token": "string",  "versions": [    {      "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    }  ]}