AlmondTill/G3N API

On this page

takeConsultationPlan

mutation · in the family Work and notes

What it does

Take a drafted plan from one of Aldric's replies — a scratchpad is created with it, ready for your review and approval.

TAKE the drafted plan from ONE of Aldric's replies: the plan RE-VALIDATES fresh through the setScratchpadPlan validate/mark path (stale steps arrive MARKED), the Scratchpad births parented to YOU (the birth cause narrates the consultation + turn), and the turn takes the SET-ONCE takenScratchpadId stamp — a second take refuses CONFLICT/REFERENCED naming the standing walk. Legal on open AND closed consultations (the drafted work outlives the conversation); your ≤16 open-scratchpad bound applies. Returns the born Scratchpad — review, approve, realize under your own gates (the hardened-Aldric law). Requires authentication (user sessions) + the record's current revision.

What happens

The plan is re-checked against the live system at take time (a step that no longer checks out arrives marked). The turn remembers which scratchpad it became — taking the same reply twice is refused; the walk lives on the scratchpad.

Careful

Nothing real is created until you approve and realize the scratchpad under your own permissions.

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.
seqInt Int!yesNo further notes.
reasonStringnoNo 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 ExampleTakeConsultationPlan($id: ID!, $revision: ID!, $seq: Int!, $reason: String) {
  takeConsultationPlan(id: $id, revision: $revision, seq: $seq, reason: $reason) {
    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",
  "seq": 1,
  "reason": "Correcting a miscount."
}

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

Example response

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