On this page
takeSuggestion
mutation · in the family Work and notes
What it does
Take a suggestion — a scratchpad is created with its drafted plan, ready for your review and approval.
TAKE a suggestion: mints a Scratchpad THROUGH THE LIVE SPINE — origin suggestion, parented to YOU, the caption carried, the WHY as the intent, and the drafted plan landed via the setScratchpadPlan validate/mark path VERBATIM (a step that no longer checks out arrives MARKED, never silently repaired; the standing diff preview shows it). The offer law gates the act (every drafted step must be runnable under YOUR OWN capability — AUTHZ/FORBIDDEN naming the steps otherwise; preview ≡ enforcement) and your ≤16 open-scratchpad bound applies. The suggestion flips open→taken stamping takenScratchpadId in the SAME write; a lost race compensates (the fresh scratchpad abandons, reason narrated) and surfaces CONFLICT. A past-expiry open refuses CONFLICT/EXPIRED, lazily expiring on the touch. Returns the born Scratchpad — approve and realize it under your own gates (the hardened-Aldric law). Requires authentication (user sessions) + the record's current revision. Template class.
What happens
You can only take a suggestion whose plan your own permissions could run. The scratchpad carries the plan exactly as drafted (a step that no longer checks out arrives marked, never silently fixed); nothing real is created until you approve and realize it yourself.
Careful
Taking closes the offer for everyone — the work then lives on your scratchpad.
Who may call it
Capability area: Work and notes — Tasks, notes, messages, dashboards and the everyday tools every staff member keeps.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:takeSuggestion
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
input | TakeSuggestionInput TakeSuggestionInput! | yes | No 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 ExampleTakeSuggestion($input: TakeSuggestionInput!) {
takeSuggestion(input: $input) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
origin
intent
planRevision
approvedPlanRevision
inFlightSeq
realizationFault
}
}
Variables:
{
"input": {
"id": "01900000-0000-7000-8000-37386ae00000",
"revision": "01900000-0000-7000-8000-b7960e180000",
"reason": "Correcting a miscount."
}
}
Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.
Example response
{
"data": {
"takeSuggestion": {
"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
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)