files.com/docs/models/AutomationRun.md

Files.com SDK for JavaScript

# AutomationRun

## Example AutomationRun Object

```
{
  "id": 1,
  "automation_id": 1,
  "completed_at": "2000-01-01T01:00:00Z",
  "created_at": "2000-01-01T01:00:00Z",
  "retry_at": "2000-01-01T01:00:00Z",
  "retried_at": "2000-01-01T01:00:00Z",
  "retried_in_run_id": 1,
  "retry_of_run_id": 1,
  "runtime": 1.0,
  "status": "success",
  "successful_operations": 1,
  "failed_operations": 1,
  "status_messages_url": "https://www.example.com/log_file.txt"
}
```

* `id` (int64): ID.
* `automation_id` (int64): ID of the associated Automation.
* `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.
* `runtime` (double): Automation run runtime.
* `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
* `successful_operations` (int64): Count of successful operations.
* `failed_operations` (int64): Count of failed operations.
* `status_messages_url` (string): Link to status messages log file.

---

## List Automation Runs

```
await AutomationRun.list({
  'user_id': 1,
  'automation_id': 1,
})
```


### Parameters

* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
* `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ automation_id, status ]`.
* `automation_id` (int64): Required - ID of the associated Automation.

---

## Show Automation Run

```
await AutomationRun.find(id)
```


### Parameters

* `id` (int64): Required - Automation Run ID.