API reference
Create a study
Start a study and its Planner plan: a new parent job, or an existing one checked first. If the plan cannot be made, nothing is stored.
Needs scope cases:write.
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.
iohr.cases.v1.CreateStudyRequest; path variables override their fields
application/json- body
iohr.cases.v1.CreateStudyRequest
company?stringdate?stringplan_id?stringslug?stringstatus?stringtext?iohr.cases.v1.StudyText
website?stringiohr.cases.v1.CreateStudyResponse
application/json- response
iohr.cases.v1.CreateStudyResponse
study?iohr.cases.v1.Study
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.createStudy({ company: "<company>", date: "<date>", slug: "<slug>", status: "<status>", }); 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.
{ "study": { "company": "string", "created_at": "string", "created_by": "string", "current_version": 0, "date": "string", "plan_id": "string", "slug": "string", "status": "string", "study_id": "string", "text": { "en": { "markdown": "string", "summary": "string", "title": "string" }, "hr": { "markdown": "string", "summary": "string", "title": "string" } }, "updated_at": "string", "website": "string" }}