AlmondTill/G3N API

Scratchpad

The Scratchpad family — 5 operations.

A scratchpad collects intent until it holds a plan — ordered steps in the API’s own vocabulary — and, once a person approves it, realizes the plan into records through the ordinary operations under the approving caller’s own permissions. Invalid steps are marked, never repaired; a marked plan can be read but never approved.

Operations

OperationKindWhat it does
createScratchpadmutationCreate a new scratchpad — a plan of records to create, reviewed and approved before anything is born at your organization.
scratchpadqueryLook up one record — a scratchpad — a plan of records to create, reviewed and approved before anything is born.
scratchpadsqueryThe scratchpad list — each entry is a scratchpad — a plan of records to create, reviewed and approved before anything is born.
transitionScratchpadmutationMove a scratchpad through its life — hold the plan for review, reopen it for editing, approve it, or abandon it.
updateScratchpadmutationEdit a scratchpad — a plan of records to create, reviewed and approved before anything is born — change its details.