Automation Authoring Schemas

Show the Automation v2 authoring schema and active node catalog

SDK Method

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 Automation from 'files.com/lib/models/Automation';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const automationAuthoringSchema = await Automation.getAuthoringSchema();
  // Operate on automationAuthoringSchema
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw 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.