media_get_optimizations_runs: Check status of a run

Description Usage Arguments Value

View source: R/generated_client.R

Description

Check status of a run

Usage

1

Arguments

id

integer required. The ID of the optimization.

run_id

integer required. The ID of the run.

Value

A list containing the following elements:

id

integer, The ID of the run.

optimizationId

integer, The ID of the optimization.

state

string, The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.

isCancelRequested

boolean, True if run cancel requested, else false.

startedAt

string, The time the last run started at.

finishedAt

string, The time the last run completed.

error

string, The error, if any, returned by the run.


civis documentation built on July 2, 2020, 12:44 a.m.