Automation Execution Nodes

Show Automation Run Node

Endpoint

GET/automation_runs/{id}/node

Return Object

AutomationExecutionNode

Authorization Requirement

Available to all authenticated keys or sessions.

Request Parameters

ParameterDescription
id
int64
Required
Automation Run ID.
node_id
string
Required
Node ID from the pinned Automation definition.

Example Request

curl "https://app.files.com/api/rest/v1/automation_runs/{id}/node.json?node_id=node_id" \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "node_id": "example",
  "node_type": "example",
  "status": "example",
  "run_stage": "example",
  "reused": true,
  "successful_operations": 1,
  "failed_operations": 1,
  "started_at": "2000-01-01T01:00:00Z",
  "completed_at": "2000-01-01T01:00:00Z",
  "duration_ms": 1,
  "inputs": [
    "example"
  ],
  "outputs": "example",
  "input_items": "example",
  "output_items": "example"
}

The AutomationExecutionNode Object

Some of the endpoints above return a AutomationExecutionNode object. The attributes of this object are listed below.

AttributeDescription
node_id
string
Node ID from the pinned Automation definition.
node_type
string
Node type.
status
string
Node status.
run_stage
string
Current node execution stage.
reused
boolean
Whether this node reused persisted output from an earlier run.
successful_operations
int64
Count of successful operations in this node.
failed_operations
int64
Count of failed operations in this node.
started_at
date-time
When this node started.
completed_at
date-time
When this node completed.
duration_ms
int64
Node runtime in milliseconds.
inputs
array(object)
Ordered inbound edge references.
outputs
object
Output counts, item kinds, and typed-error summaries by outlet.
input_items
object
Materialized input items currently available, grouped by inlet.
output_items
object
Materialized output items grouped by outlet.

Example AutomationExecutionNode Object

{
  "node_id": "example",
  "node_type": "example",
  "status": "example",
  "run_stage": "example",
  "reused": true,
  "successful_operations": 1,
  "failed_operations": 1,
  "started_at": "2000-01-01T01:00:00Z",
  "completed_at": "2000-01-01T01:00:00Z",
  "duration_ms": 1,
  "inputs": [
    "example"
  ],
  "outputs": "example",
  "input_items": "example",
  "output_items": "example"
}