Automation Authoring Schemas

Show the Automation v2 authoring schema and active node catalog

SDK Method

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

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    "github.com/Files-com/files-sdk-go/v3/automation"
)

automationAuthoringSchema, err := automation.GetAuthoringSchema()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

The AutomationAuthoringSchema Object

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

AttributeDescription
DefinitionSchema
object		JSON Schema for active Automation v2 graph definitions.
ErrorFamilies
array(object)		Typed error families accepted by Automation v2 on_error rules.
Nodes
array(object)		Active Automation v2 node authoring metadata.
SchemaUrl
string		Stable public URL for the Automation v2 graph definition JSON Schema.