Automation Authoring Schemas

Show the Automation v2 authoring schema and active node catalog

Command

files-cli automations get-authoring-schema

Output

Outputs a AutomationAuthoringSchema object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Example Request

files-cli automations get-authoring-schema

The AutomationAuthoringSchema Object

Some of the commands above return a AutomationAuthoringSchema object. The attributes of this object are listed below.

AttributeDescription
definition_schema
object
JSON Schema for active Automation v2 graph definitions.
error_families
array(object)
Typed error families accepted by Automation v2 on_error rules.
nodes
array(object)
Active Automation v2 node authoring metadata.
schema_url
string
Stable public URL for the Automation v2 graph definition JSON Schema.