Automation Authoring Schemas

Show the Automation v2 authoring schema and active node catalog

Endpoint

GET/automations/authoring_schema

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

curl https://app.files.com/api/rest/v1/automations/authoring_schema.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "definition_schema": "example",
  "error_families": [
    "example"
  ],
  "nodes": [
    "example"
  ],
  "schema_url": "example"
}

The AutomationAuthoringSchema Object

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

Example AutomationAuthoringSchema Object

{
  "definition_schema": "example",
  "error_families": [
    "example"
  ],
  "nodes": [
    "example"
  ],
  "schema_url": "example"
}