Automation
Requires access scope.
A valid field path through the Admin API schema for use in an automation workflow.
Anchor to FieldsFields
- description (String)
- leafType (String!)
- path (String!)
- pathElementsTypes ([String!]!)
- searchCategories ([String!]!)
- Anchor to descriptiondescription•String
A description of the value at the end of the path.
- Anchor to leafTypeleaf•String!
Type non-null The type of the value at the end of the path.
- Anchor to pathpath•String!non-null
The field path, including its root, such as
order.customer.email.- Anchor to pathElementsTypespath•[String!]!
Elements Types non-null The field name and named type of each path element, in traversal order.
- Anchor to searchCategoriessearch•[String!]!
Categories non-null The search filter categories this path belongs to.
Anchor to QueriesQueries
- automationEnvironmentPaths (AutomationEnvironmentPathConnection!)
- •query
Returns field paths available from a root type, ordered by relevance to the search query.
Show fields
- Anchor to afterafter•String
Return matches after this cursor.
- Anchor to beforebefore•String
Return matches before this cursor. Requires last.
- Anchor to dataTypeFilterdata•Automation
Type Filter Environment Path Data Type Default:ALL Restricts results by leaf data type.
Show enum values
- Anchor to firstfirst•Int
The number of matches after the cursor. Defaults to 10; maximum 40.
- Anchor to includeDeprecatedinclude•Boolean
Deprecated Default:false Include deprecated fields that still exist in the selected schema.
- Anchor to lastlast•Int
The number of matches before the cursor. Requires before; maximum 40.
- Anchor to queryquery•String!required
A natural-language description of the field to find.
- Anchor to rootTyperoot•String!
Type required The Admin API type to search from, such as
Order.- Anchor to scalarTypesscalar•[String!]
Types Schema leaf type names to match, including custom scalars and enums. Omitted or null selects any type. Empty arrays and scalarTypes with dataTypeFilter LIST are invalid.
- Anchor to versionversion•String
The automation version to search. Requires
.- Anchor to workflowIdworkflow•ID
Id The automation whose Admin API version should be searched.
Arguments