AlmondTill/G3N API

On this page

doomZone

mutation · in the family Zone

What it does

Permanently retire a zone — a named area inside a facility.

Doom (terminal) a Zone by id; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards; a doomed Zone is immutable + never deleted. The optional reason rides the transition events.

Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

Who may call it

Capability area: Places and layout — How your organizations and facilities are arranged day to day — facilities, zones and bins, teams and labels.

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

Zone Zone! — A zone — a subdivision of a LogicalFacility (an LF has one or more; the granularity between the LF and its Bins). Parent = its LogicalFacility (NOT the family root). A policy level; the holdable-inventory characteristics are a LATER slice (they arrive with the Characteristic construct).

Example request

mutation ExampleDoomZone($id: ID!, $revision: ID!, $reason: String) {
  doomZone(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    coordinates
    code
  }
}

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": {
    "doomZone": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "ZN-EXMP-0000-000F",
      "type": "Zone",
      "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",
      "coordinates": "<coordinates>",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer