AlmondTill/G3N API

OptionGroup

object type

An option group — the PICK-SOURCE for option dimensions (a size run, a brand color palette), typed from the canned registry (color/size drive the spine tier defaults; custom groups feed descriptive attributes that never explode variants). Holds ordered OptionValue children (their parent). NO org selection ever. Referenced BY Style schemes at the spine.

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 (OP-…).
typeString String!The kind of record — always OptionGroup 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 an OptionGroup 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.
optionGroupTypeOptionGroupType OptionGroupType!The pick-source kind — set at creation, IMMUTABLE thereafter.
codeStringOptional mutable merchant reference code; uniqueness NOT enforced (the code stance).
defaultSizeRunIdIDThe dimension DEFAULT SizeRun: the run a style over this group fills its matrix with when it names none of its own; the run must be ACTIVE and over THIS group; set by update only (a run must exist first), EXPLICIT-null-clearable; absent = no default.

Used by