Sign in
InOrbit
Docs
Have a token? Manage tokens in the console
GET
/v1/decisions/spaces/{space_id}/diagrams/{diagram_id}

A diagram's model (elements, links, boundaries) at its current version or at version.

Needs scope decisions:read.

Authorization

bearer
headerAuthorizationBearer <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.

Path Parameters

space_id*string

The space's id, lab_ and a ULID, from List spaces.

diagram_id*string

The diagram's id, ldia_ and a ULID, from List diagrams.

Query Parameters

version?integer

A version number; 0 for the current one.

Formatint32
svg?boolean

Response Body

iohr.decisions.v1.GetDiagramResponse

application/json
  1. response

iohr.decisions.v1.GetDiagramResponse

diagram?

iohr.decisions.v1.Diagram

model*string
svg*string
used_in*array<>
version*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.decisions.getDiagram("<space_id>", "<diagram_id>");  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.

{  "diagram": {    "created_at": "string",    "created_by": "string",    "current_version": 0,    "diagram_id": "string",    "element_kinds": [      "string"    ],    "kind": "string",    "name": "string",    "nodes": 0,    "space_id": "string",    "space_name": "string",    "svg_path": "string",    "updated_at": "string",    "used_in_count": 0  },  "model": "string",  "svg": "string",  "used_in": [    {      "display_number": "string",      "document_id": "string",      "kind": "string",      "number": 0,      "position": 0,      "space_id": "string",      "status": "string",      "title": "string"    }  ],  "version": 0}

List diagrams GET

The space's architecture diagrams, newest change first. Needs scope `decisions:read`.

List a diagram's versions GET

Who saved each version of a diagram, when and why, newest first. Draw one with Get a diagram's `version` and `svg`. Needs scope `decisions:read`.