civis (version 3.0.0)

enhancements_get_cass_ncoa_runs: Check status of a run

Description

Check status of a run

Usage

enhancements_get_cass_ncoa_runs(id, run_id)

Value

A list containing the following elements:

id

integer, The ID of the run.

cassNcoaId

integer, The ID of the cass_ncoa.

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.

Arguments

id

integer required. The ID of the cass_ncoa.

run_id

integer required. The ID of the run.