Automation Authoring Schemas

Show the Automation v2 authoring schema and active node catalog

SDK Method

files_sdk.automation.get_authoring_schema()

Return Object

AutomationAuthoringSchema

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Folder Administrator for the relevant folder.

Example Request

import files_sdk

try:
  automation_authoring_schema = files_sdk.automation.get_authoring_schema()
  # Operate on automation_authoring_schema
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The AutomationAuthoringSchema Object

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

Attribute	Description
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.