Sign in
Docs
API referenceDecisions

API reference

What a document's evidence shows

Have a token? Manage tokens in the console
GET
/v1/work/status/{document_id}

A document's pieces, each with the state it claims, the state its evidence shows, and a finding where they disagree.

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

document_id*string

The document.

Query Parameters

space_id?string

The space it is in.

repository?string

The repository its pull requests are in, owner/name; empty for any.

Response Body

iohr.work.v1.StatusResponse

application/json
  1. response

iohr.work.v1.StatusResponse

findings*integer
Formatint32
pieces*array<>
unchecked*integer
Formatint32
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.work.status("<document_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
{  "findings": 0,  "pieces": [    {      "claimed": "string",      "evidence": "string",      "finding": "string",      "line": 0,      "name": "string",      "pull_requests": [        0      ]    }  ],  "unchecked": 0}