AlmondTill/G3N API

On this page

orgLayout

query · in the family Reading your records

What it does

Your organization’s operational map in one call — every physical facility (with its location site), the logical facilities inside each, and the registers inside those.

The ACTING org's operational layout in ONE call — Organization → PhysicalFacilities (each naming its referenced location site) → LogicalFacilities → Registers, every level sysId-ordered ('map my org' answered whole; the orgBus synopsis posture: opening a record still enforces per-op capability). No arguments — the session's acting org IS the subject. Requires authentication.

What happens

Read-only. Answers for the organization you are signed into; no arguments needed.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Returns

OrgLayout OrgLayout! — The acting org's operational tree in one read: Organization → PhysicalFacilities → LogicalFacilities → Registers. truncated = the antifragile node bound trimmed the deepest levels (real merchants never reach it).

Example request

query ExampleOrgLayout {
  orgLayout {
    truncated
  }
}

Example response

{
  "data": {
    "orgLayout": {
      "truncated": true
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer