imports_post_cancel {civis}R Documentation

Cancel a run

Description

Cancel a run

Usage

imports_post_cancel(id)

Arguments

id

integer required. The ID of the job.

Value

A list containing the following elements:

id

integer, The ID of the run.

state

string, The state of the run, one of 'queued', 'running' or 'cancelled'.

isCancelRequested

boolean, True if run cancel requested, else false.


[Package civis version 3.1.2 Index]