imports_list_batches {civis}

List batch imports

Description

List batch imports

Usage

imports_list_batches(
  hidden = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

hidden

boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

limit

integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.

page_num

integer optional. Page number of the results to return. Defaults to the first page, 1.

order

string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at.

order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

Value

An array containing the following fields:

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.