AlmondTill/G3N API

On this page

setScratchpadPlan

mutation · in the family Work and notes

What it does

Write or replace the whole plan on a draft scratchpad — the ordered list of records it will create.

Write or REPLACE the whole plan on a DRAFT scratchpad: the ordered create steps (≤24; seq assigned by position server-side). Every step validates against the LIVE registry + wire schema RIGHT HERE — an invalid step is MARKED with the exact problem and kept as written, never silently repaired; a plan with marked steps can be reviewed (ready) but can never be approved. A step's input may cite an earlier step's created record with the literal string @step:<n>. Bumps planRevision (the approval pin's subject). Refuses CONFLICT/REF_STATE outside draft (reopen first — the review hold freezes the plan). Requires authentication (user sessions) + the record's current revision. Template class (universal staff work).

What happens

Each step names a create operation and its input. Every step is checked immediately; a step that fails the check is MARKED with the exact problem and kept as written — nothing is silently fixed. A plan with marked steps can be reviewed but not approved. A step may reference an earlier step’s created record with @step:<n>.

Who may call it

Capability area: Work and notes — Tasks, notes, messages, dashboards and the everyday tools every staff member keeps.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
stepsScratchpadPlanStepInput [ScratchpadPlanStepInput!]!yesNo further notes.

Returns

Scratchpad Scratchpad! — A Scratchpad: collects intent (free text now; wizard answers/imports/suggestions/consultations mint through their own entrances later) until it holds a PLAN — ordered {operation, input} steps in wire vocabulary (≤24; creates-only v1: each operation must be a live create-class registry mutation) — and, once a human approves, REALIZES the plan into born constructs through the ordinary ops under the realizing caller's OWN session and capability (the hardened-Aldric law: the spine holds ZERO special authority; AI is just one plan author, and the spine never knows the difference). USER-parented (the collector owns the walk), group-rooted. Invalid steps are MARKED, never repaired; a marked plan can be ready for human eyes but can never be approved. Approval PINS the plan revision (the approved plan IS the executed plan); realization is idempotent + convergent-resume (the realized-id stamps are the idempotency keys) and every step's born cause narrates the scratchpad. The ops event domain (at.ops.scratchpad.*).

Example request

mutation ExampleSetScratchpadPlan($id: ID!, $revision: ID!, $steps: [ScratchpadPlanStepInput!]!) {
  setScratchpadPlan(id: $id, revision: $revision, steps: $steps) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    origin
    intent
    planRevision
    approvedPlanRevision
    inFlightSeq
    realizationFault
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "steps": [
    {
      "operation": "<operation>",
      "input": "<input>"
    }
  ]
}

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

Example response

{
  "data": {
    "setScratchpadPlan": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SD-EXMP-0000-000F",
      "type": "Scratchpad",
      "caption": "Blue jeans",
      "status": "draft",
      "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",
      "origin": "<origin>",
      "intent": "<intent>",
      "planRevision": 1,
      "approvedPlanRevision": 1,
      "inFlightSeq": 1,
      "realizationFault": "<realization fault>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in