imports_get_batches {civis}

Get details about a batch import

Description

Get details about a batch import

Usage

imports_get_batches(id)

Arguments

id

integer required. The ID for the import.

Value

A list containing the following elements:

id

integer, The ID for the import.

schema

string, The destination schema name. This schema must already exist in Redshift.

table

string, The destination table name, without the schema prefix. This table must already exist in Redshift.

remoteHostId

integer, The ID of the destination database host.

state

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

startedAt

string, The time the last run started at.

finishedAt

string, The time the last run completed.

error

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

hidden

boolean, The hidden status of the item.