API reference
Link a job
Link a coordinator job to a document, by its job id, as what implements it or a part of it. Linking one already linked changes its role. A document holds at most 500 jobs.
Needs scope decisions:write.
bearerAuthorizationBearer <token>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.
space_id*stringThe space.
document_id*stringThe document's id, or what people call it (RFC 0120, prd-39).
iohr.decisions.v1.LinkJobRequest; path variables override their fields
application/json- body
iohr.decisions.v1.LinkJobRequest
document_id?stringjob_id?stringrole?stringspace_id?stringiohr.decisions.v1.LinkJobResponse
application/json- response
iohr.decisions.v1.LinkJobResponse
created*booleanlink?iohr.decisions.v1.JobLink
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.decisions.linkJob("<space_id>", "<document_id>", { role: "<role>" }); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}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.
{ "created": true, "link": { "document_id": "string", "job_id": "string", "linked_at": "string", "linked_by": "string", "role": "string", "via": "string" }}List jobs GET
The coordinator jobs linked to a document now, newest link first, with their role, who linked them and when. Unlinked jobs are left out. Needs scope `decisions:read`.
Unlink a job POST
Unlink a coordinator job from a document, by its job id. The link's history is kept. Needs scope `decisions:write`.