scripts_list_history {civis}R Documentation

Get the run history and outputs of this script

Description

Get the run history and outputs of this script

Usage

scripts_list_history(id)

Arguments

id

integer required. The ID for the script.

Value

A list containing the following elements:

id

integer, The ID of this run.

sqlId

integer, The ID of this sql.

state

string, The state of this run.

isCancelRequested

boolean, True if run cancel requested, else false.

finishedAt

string, The time that this run finished.

error

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

output

array, An array containing the following fields:

  • outputName string, The name of the output file.

  • fileId integer, The unique ID of the output file.

  • path string, The temporary link to download this output file, valid for 36 hours.


[Package civis version 3.0.0 Index]