civis (version 3.0.0)

jobs_list_runs: List runs for the given job

Description

List runs for the given job

Usage

jobs_list_runs(
  id,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Value

An array containing the following fields:

id

integer,

state

string,

createdAt

string, The time that the run was queued.

startedAt

string, The time that the run started.

finishedAt

string, The time that the run completed.

error

string, The error message for this run, if present.

Arguments

id

integer required. The ID for this job.

limit

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

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 id. Must be one of: id.

order_dir

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