AlmondTill/G3N API

TrainingRequirement

object type

A TrainingRequirement (🎓 — THE TRAINING PROGRAM, THE WIRE): the owner's rule that people holding a role copied from the canned template roleTemplateKey must hold a VALID TrainingCertificate for the course courseKey — a LIVE play key of the Playbook registry. graceDays (0..365, default 14) = the days after the role grant before the requirement falls due; passMark (1..100, default 80) = the mark a sitting must reach — the STRICTEST rule binding the person for the course wins at an attempt's start. The pair (roleTemplateKey, courseKey) is IMMUTABLE after birth and UNIQUE among the org's non-doomed rules (a duplicate refuses CONFLICT/IDENTITY_TAKEN); at most 100 rules per org (CONFLICT/TRAINING_CAP past it). NOT searchable (no filter roster until the face).

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 (TE-…).
typeString String!The kind of record — always TrainingRequirement 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 TrainingRequirement 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.
roleTemplateKeyString String!The canned role template the rule binds — owner · system_administrator · manager · associate_manager · warehouse_associate · sales_associate · cashier; a person holding ANY role copied from it owes the course. IMMUTABLE at birth.
courseKeyString String!The course — a LIVE play key of the Playbook registry (e.g. connect-a-till). IMMUTABLE at birth.
graceDaysInt Int!Days after the role grant before the requirement is due (0..365; default 14).
passMarkInt Int!The pass mark a sitting must reach (1..100; default 80) — the strictest applicable rule wins.
noteStringWhat the rule is for (at most 400 characters); optional, set-only.

Used by