AlmondTill/G3N API

Decoration

object type

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).

Fields

FieldTypeNotes
idID ID!The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it.
sysIdString String!The group-scoped human-facing system id (DC-…).
typeString String!The kind of record — always Decoration here.
captionString String!The record’s display name — what people see it called.
statusString String!The FSM state: active | inactive | doomed.
parentIdID ID!The parent org group; for a Decoration parentId === rootId.
rootIdID ID!The org-group family root.
createdAtString String!When the record was created, as a UTC timestamp.
updatedAtString String!When the record last changed, as a UTC timestamp.
revisionNumInt Int!How many times this record has been edited; the first save is 0.
revisionID ID!The OCC revision token — supply it on every mutation of this record; rotates on every write.
refCaptionsRefCaption [RefCaption!]!The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption.
purposeString String!The canned purpose key. Server-validated (the hyphenated canned keys are not enum-safe); IMMUTABLE after birth.
localeString String!The content locale — canonical BCP-47 core shape (en, en-US, fr-CA, zh-Hans-CN); case-canonical, STRICT. Mutable.
ordinalInt Int!The importance position among same-(owner,purpose,locale) decorations. Always present (defaults to 0 at create); mutable.
textString String!The inline text content. Mutable, replace-only.
attachedToTypeAttachableType AttachableType!The owning construct type. IMMUTABLE after birth.
attachedToIdID ID!The owning construct id. IMMUTABLE after birth (moving content = recreate).
codeStringOptional mutable merchant reference code; uniqueness NOT enforced (the code stance).

Used by