AlmondTill/G3N API

On this page

copyCannedCharacteristic

mutation · in the family Catalog structure

What it does

Copy a platform-preset product characteristic you can copy into your group into your own group — your editable copy of the platform preset.

Copy a canned Characteristic template into 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.

Arguments

NameTypeRequiredNotes
inputCopyCannedCharacteristicInput CopyCannedCharacteristicInput!yesNo further notes.

Returns

Characteristic Characteristic! — A characteristic — a master-list entry for VALIDATED product values (serial-number, warranty period, …): value type + validation grammar + optional unit; distinct from Tags (unstructured labels), Categories (navigation), and Options (variant-driving). Canned + custom: system-shipped IMMUTABLE templates are copied via copyCannedCharacteristic; group-defined customs are created directly — references (the Manufacturer format map; the spine) always point at group-owned constructs, never templates. TWO_STATE — no inactive (a master-list entry is usable or gone).

Example request

mutation ExampleCopyCannedCharacteristic($input: CopyCannedCharacteristicInput!) {
  copyCannedCharacteristic(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    valueType
    unit
    code
  }
}

Variables:

{
  "input": {
    "key": "<key>",
    "caption": "Blue jeans"
  }
}

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

Example response

{
  "data": {
    "copyCannedCharacteristic": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "CH-EXMP-0000-000F",
      "type": "Characteristic",
      "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",
      "valueType": "string",
      "unit": "<unit>",
      "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