AlmondTill/G3N API

On this page

orgBus

query · in the family Reading your records

What it does

What’s happening across your whole organization — every create, edit, and status change on every record, newest first, over roughly the last three months.

Your tenant's event bus. constructTypes filters to those construct types (the type chips — unknown names refuse VALIDATION); includeSystem (default false) admits the platform's OWN changes — the system actor's rows and actor-less rows — which the walk otherwise folds, so a page counts the rows a reader will SEE; limit defaults 50, clamps at 100. Requires authentication.

What happens

Read-only. Each card shows the record as it stood at that moment; older history lives on each record’s own change history.

Who may call it

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

Arguments

NameTypeRequiredNotes
limitIntnoHow many records to answer at most; a page may hold fewer.
nextTokenStringnoThe cursor from the previous page, passed back exactly as received.
constructTypesString [String!]noNo further notes.
includeSystemBooleannoNo further notes.

Returns

OrgBusEntryPage OrgBusEntryPage! — One page of the tenant event walk.

This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.

Example request

query ExampleOrgBus($limit: Int) {
  orgBus(limit: $limit) {
    items {
      id
      constructType
      constructId
      constructSysId
      caption
      status
      causeKind
      causeEvent
      causeOp
      causeReason
      constructRevisionNum
      occurredAt
    }
    nextToken
  }
}

Variables:

{
  "limit": 1
}

Example response

{
  "data": {
    "orgBus": {
      "items": [
        {
          "id": "01900000-0000-7000-8000-37386ae00000",
          "constructType": "<construct type>",
          "constructId": "01900000-0000-7000-8000-dca71e5f0000",
          "constructSysId": "<construct sys id>",
          "caption": "Blue jeans",
          "status": "<status>",
          "causeKind": "<cause kind>",
          "causeEvent": "<cause event>",
          "causeOp": "<cause op>",
          "causeReason": "<cause reason>",
          "constructRevisionNum": 1,
          "occurredAt": "2027-01-31T00:00:00.000Z"
        }
      ],
      "nextToken": "<the cursor from the previous page>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer