imports_get_files_csv_runs {civis}

Check status of a run

Description

Check status of a run

Usage

imports_get_files_csv_runs(id, run_id)

Arguments

id

integer required. The ID of the csv_import.

run_id

integer required. The ID of the run.

Value

A list containing the following elements:

id

integer, The ID of the run.

csvImportId

integer, The ID of the csv_import.

state

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

isCancelRequested

boolean, True if run cancel requested, else false.

createdAt

string, The time the run was created.

startedAt

string, The time the run started at.

finishedAt

string, The time the run completed.

error

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