automations_read
Arguments
required
The whole definition to check.
Show fields
Show fields
required
String!
required
The automation’s name.
String
The checker rules to hold it to. Omitted: a saved automation keeps its own, and a new one gets the newest.
required
The steps, at most 500.
Show fields
Show fields
String
A
core.function step’s TypeScript code; only that kind takes it.The kind’s settings, matching the
configJsonSchema of this kind and version in automationKinds.String
A note on the step.
Boolean
Skip the step when the automation runs.
String!
required
The step’s id, unique in the automation.
String!
required
The step kind, such as
core.wait.Int!
required
The version of the kind the config is written for.
Where it sits on the canvas.
String
The step’s name; omitted shows the kind’s title.
required
What starts a run.
Show fields
Show fields
The kind’s settings, matching the
configJsonSchema of this kind and version in automationKinds.String
A note on the trigger.
String!
required
The trigger kind, such as
core.schedule.Int!
required
The version of the kind the config is written for.
Where it sits on the canvas.
Returns
required
An automation checked as publishing checks it, with the types its expressions can use.
Show fields
Show fields
required
Its problems. Any ERROR blocks publishing.
Show fields
Show fields
String!
required
A stable code, such as F0004. Read
diagnostics/<code> in automationCatalog.required
Suggested fixes, best first.
Show fields
Show fields
required
The definition with the fix applied.
Boolean!
required
It fills in a placeholder you should check first.
String!
required
What the fix does.
String!
required
What is wrong.
[String!]
Where in that step it is, such as
["config", "seconds"]; without a step, where in the definition. Null when it has no one place.String!
required
The rules version its code arrived in. An error from a version newer than the automation’s is reported as a WARNING.
required
How much it matters. ERROR blocks publishing.
String
"trigger" or the id of the step it is on; null for the automation as a whole.String
The type
entryCondition reads, defined in typesSDL.required
Each step, in the definition’s order.
Show fields
Show fields
String
The type expressions in the step read, defined in
typesSDL. Null when the automation can’t be typed.String!
required
The step’s id.
String
The type later steps read from it under
steps; null when it produces nothing.required
String
A one-line description of its settings.
String
GraphQL SDL of every type the context and step outputs use. Null when the automation can’t be typed, such as an unknown trigger.
Example
query {
automationCheck(definition: { ... }) {
entryContextType
typesSDL
}
}