Automation Authoring Schemas

Show the Automation v2 authoring schema and active node catalog

SDK Method

\Files\Model\Automation::getAuthoringSchema;

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

try {
  $automation_authoring_schema = \Files\Model\Automation::getAuthoringSchema();
  // Operate on $automation_authoring_schema
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The AutomationAuthoringSchema Object

Some of the methods 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.