AlmondTill/G3N API

On this page

doomPhysicalFacilityLocation

mutation · in the family Physical facility location

What it does

Permanently retire a facility address — where a physical facility sits.

Doom (terminal) a PhysicalFacilityLocation by id, within the caller's org group; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards: a PFL still referenced by a live PhysicalFacility is refused (CONFLICT/REFERENCED — detail carries the blocking refs); a non-active PFL is refused (CONFLICT/FSM_TRANSITION_INVALID). A cross-tenant id is forbidden + trips the rootId tripwire. 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: Organization structure — Opening and closing organizations and facilities — the legal and physical structure of your group.

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

PhysicalFacilityLocation PhysicalFacilityLocation! — A physical facility location — the SOLE holder of a street address (the PFL→PF→LF→Zone→Bin hierarchy); the first data-plane construct.

Example request

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

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

Errors this call can answer