civis (version 3.1.2)

enhancements_post_geocode_runs: Start a run

Description

Start a run

Usage

enhancements_post_geocode_runs(id)

Value

A list containing the following elements:

id

integer, The ID of the run.

geocodeId

integer, The ID of the geocode.

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.

Arguments

id

integer required. The ID of the geocode.