AlmondTill/G3N API

On this page

doomDashboard

mutation · in the family Dashboard

What it does

Permanently retire a dashboard layout.

Doom (terminal) a Dashboard — a layout carries no referents, so doom is always free. Requires the unrestricted capability + the CURRENT revision.

What happens

Permanent; nothing references a layout.

Who may call it

Capability area: Work and notes — Tasks, notes, messages, dashboards and the everyday tools every staff member keeps.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

Dashboard Dashboard! — A Dashboard: a merchant-authored CANNED-METRIC widget layout (no ad-hoc OLAP: the construct stores the LAYOUT only; every output derives downstream of the event lake; the office renderer realizes the tokens when the face lands). widgets = 1..16 ordered rows, each naming ONE canned metric (the v1 roster: sales_today · sales_week · orders_open · sell_through_30d · inventory_value · low_stock_count · cs_open_cases · review_average · loyalty_signups_30d · fraud_alerts_open); ordinals unique; wholesale-replace on edit. NOT searchable.

Example request

mutation ExampleDoomDashboard($id: ID!, $revision: ID!, $reason: String) {
  doomDashboard(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "doomDashboard": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "DA-EXMP-0000-000F",
      "type": "Dashboard",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer