AlmondTill/G3N API

On this page

doomDecoration

mutation · in the family Decoration

What it does

Permanently retire a decoration — extra display content attached to a record (images, blurbs).

Doom (terminal) a Decoration by id; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards; a doomed Decoration 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: Catalog structure — Creating and retiring catalog families and whole items.

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

Decoration Decoration! — A decoration — the ONE purposed, localized, ordered carrier for consumer-facing content, ATTACHED to an owning construct (the decoration carries the attachment; owner records never churn). Purpose comes from the canned registry (text-kind live; MEDIA-kind purposes are refused until the blob mechanics land); locale is canonical BCP-47 (the org-default-locale floor is a resolution-time read rule, later slice); ordinal orders same-purpose content (lower = more important). Decorations are freely doomable (nothing references them); the OWNER doom is blocked by attached non-doomed decorations. inactive = draft/unpublished (content staging).

Example request

mutation ExampleDoomDecoration($id: ID!, $revision: ID!, $reason: String) {
  doomDecoration(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    purpose
    locale
    ordinal
    text
    attachedToType
    attachedToId
    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": {
    "doomDecoration": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "DC-EXMP-0000-000F",
      "type": "Decoration",
      "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",
      "purpose": "<purpose>",
      "locale": "en-CA",
      "ordinal": 1,
      "text": "Restock before the weekend.",
      "attachedToType": "Brand",
      "attachedToId": "01900000-0000-7000-8000-e744ae790000",
      "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