Sign in
Docs
API referenceCoordinator

API reference

Add or change a plan item

Have a token? Manage tokens in the console
PUT
/v1/coordinator/plans/{plan_id}/items/{item_id}

Create the item or change it. Send expected_version from the last read to refuse a write over a newer one (the answer is aborted); 0 writes whatever is there.

Needs scope coordinator:write.

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

plan_id*string

The plan's id, from List plans.

item_id*string

The item's id: a name you pick, unique in the plan.

Request Body

iohr.coordinator.v1.UpsertPlanItemRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.UpsertPlanItemRequest

account_id?string
expected_version?integer
Formatint32
holder?string
item?

iohr.coordinator.v1.PlanItem

item_id?string
plan_id?string

Response Body

iohr.coordinator.v1.UpsertPlanItemResponse

application/json
  1. response

iohr.coordinator.v1.UpsertPlanItemResponse

created*boolean
item?

iohr.coordinator.v1.PlanItem

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.coordinator.upsertPlanItem("<plan_id>", "<item_id>", { holder: "<holder>" });  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
{  "created": true,  "item": {    "ask_id": "string",    "body": "string",    "claim_fence": "string",    "diagram": "string",    "doc": "string",    "held_until": "string",    "holder": "string",    "item_id": "string",    "kind": "string",    "parent": "string",    "position": 0,    "preview": "string",    "prs": [      "string"    ],    "size": "string",    "status": "string",    "title": "string",    "updated_at": "string",    "updated_by": "string",    "version": 0  }}