Automation Authoring Schemas

Show the Automation v2 authoring schema and active node catalog

SDK Function

Automation.getAuthoringSchema()

Return Object

AutomationAuthoringSchema

Authorization Requirement

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

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.Automation;
import com.files.models.AutomationAuthoringSchema;

try {
  AutomationAuthoringSchema automationAuthoringSchema = Automation.getAuthoringSchema();
  // Operate on automationAuthoringSchema
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The AutomationAuthoringSchema Object

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