createDecoration

mutation · in the family Decoration

What it does

Create a new decoration — extra display content attached to a record (images, blurbs) at your organization.

Create a Decoration in the caller's org group; requires the unrestricted capability.

Who may call it

Capability area: Catalog structure — Creating and retiring catalog families and whole items.

• Owner
• Manager
• An API key whose scope allows api:createDecoration

Arguments

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 ExampleCreateDecoration($input: NewDecorationInput!) {
  createDecoration(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    purpose
    locale
    ordinal
    text
    attachedToType
    attachedToId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "purpose": "<purpose>",
    "locale": "en-CA",
    "text": "Restock before the weekend.",
    "attachedToType": "Brand",
    "attachedToId": "01900000-0000-7000-8000-e744ae790000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createDecoration": {
      "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

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Switch shared catalog entries on for your organization