Automation Runs

An AutomationRun is a record with information about a single execution of a given Automation.

Automation Runs can be retried upon failure or partial_failure by setting the retry_on_failure_interval_in_minutes and retry_on_failure_number_of_attempts settings on the associated Automation.

When retries occur, a new AutomationRun will be created for each retry. The property retry_at on the original run, if set, represents when that run will be retried next. The properties retried_at and retried_in_run_id will be set in the original run that failed, at the time of retry. The property retry_of_run_id will be set in the new run.

List Automation Runs

SDK Method

\Files\Model\AutomationRun::list;

Return Object

AutomationRun[]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
automation_id
int64
Required		ID of the associated Automation.

Additional Arguments

Example Request

try {
  $automation_runs = \Files\Model\AutomationRun::list([
    'automation_id' => 1
  ]);
  foreach ($automation_runs as $automation_run) {
    // Operate on $automation_run
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Automation Run

SDK Method

\Files\Model\AutomationRun::find;

Return Object

AutomationRun

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Automation Run ID.

Example Request

try {
  $automation_run = \Files\Model\AutomationRun::find($id);
  // Operate on $automation_run
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Cancel Automation Run

SDK Method

$automation_run->cancel;

Return Object

AutomationRun

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

try {
  // Find the automation_run object by its id.
  $automation_run = \Files\Model\AutomationRun::find(id);
  $automation_run->cancel();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Re-run Automation from Node

SDK Method

$automation_run->rerun;

Return Object

AutomationRun

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
node_id
string
Required		Node ID at which execution should resume.

Example Request

try {
  // Find the automation_run object by its id.
  $automation_run = \Files\Model\AutomationRun::find(id);
  $automation_run->rerun([
    'node_id' => "node_id"
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The AutomationRun Object

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

AttributeDescription
id
int64		ID.
automation_id
int64		ID of the associated Automation.
automation_version_id
int64		ID of the immutable Automation version pinned by this run.
version
int64		Pinned Automation v2 definition version.
workspace_id
int64		Workspace ID.
cancel_requested_at
date-time		Date/time at which cancellation was requested.
completed_at
date-time		Automation run completion/failure date/time.
created_at
date-time		Automation run start date/time.
retry_at
date-time		If set, this automation will be retried at this date/time due to failure or partial_failure.
retried_at
date-time		If set, this Automation run was retried due to failure or partial_failure.
retried_in_run_id
int64		ID of the run that is or will be retrying this run.
retry_of_run_id
int64		ID of the original run that this run is retrying.
rerun_of_run_id
int64		ID of the run whose persisted node outputs this run reused.
rerun_from_node_id
string		Node at which this run resumed execution.
runtime
double		Automation run runtime.
status
string		The status of the AutomationRun. One of queued, running, success, partial_failure, failure, skipped, or canceled.
Possible values: running, success, partial_failure, failure, skipped, queued, canceled
successful_operations
int64		Count of successful operations.
failed_operations
int64		Count of failed operations.
definition
object		Automation definition snapshot pinned by this run. For performance reasons, this is not provided when listing Automation runs.
node_states
object		Status and execution stage for each node in this run. For performance reasons, this is not provided when listing Automation runs.
execution_nodes
array(object)		Execution status, timing, and bounded output summaries for each node. For performance reasons, this is not provided when listing Automation runs.
journal_url
string		Link to the run journal artifact.
status_messages_url
string		Link to status messages log file.