On this page
suggestionSchema
query · in the family Suggestion schema
What it does
Look up one record — a suggestion schema — one detector the desk runs (or is parked from running) for your organization.
A SuggestionSchema by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.
What happens
Reads only — changes nothing.
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- An API key whose scope allows
api:suggestionSchema
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
SuggestionSchema — A SuggestionSchema: ONE row per (Organization × declared skill), ensure-minted lazily at the first desk refresh (authorless; the (org × skill) uniqueness marker makes the ensure race-proof). PARKING it stops the generator for the org (‘we no longer run these’ — reactivatable, owner-gated A2_STRUCTURE); DOOMING is the deliberate permanent kill (parked-first; refused CONFLICT/REFERENCED while OPEN suggestions still cite it; a doomed schema NEVER re-ensures). Every Suggestion's schemaId drills down here — provenance to the generator. The skill's declared words/watches/drafts live in the contracts SUGGESTION_SKILL_REGISTRY. The ops event domain (at.ops.suggestion_schema.*).
Example request
query ExampleSuggestionSchema($id: ID!) {
suggestionSchema(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
skill
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"suggestionSchema": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "SS-EXMP-0000-000F",
"type": "SuggestionSchema",
"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",
"skill": "<skill>"
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"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)