civis (version 3.0.0)

enhancements_get_civis_data_match_runs: Check status of a run

Description

Check status of a run

Usage

enhancements_get_civis_data_match_runs(id, run_id)

Value

A list containing the following elements:

id

integer, The ID of the run.

civisDataMatchId

integer, The ID of the civis_data_match.

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 civis_data_match.

run_id

integer required. The ID of the run.