jobs_list {civis} | R Documentation |
List Jobs
Description
List Jobs
Usage
jobs_list(
state = NULL,
type = NULL,
q = NULL,
permission = NULL,
scheduled = NULL,
hidden = NULL,
archived = NULL,
author = NULL,
limit = NULL,
page_num = NULL,
order = NULL,
order_dir = NULL
)
Arguments
state |
string optional. The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., "A,B"). |
type |
string optional. The job's type. Specify multiple values as a comma-separated list (e.g., "A,B"). |
q |
string optional. Query string to search on the id, name, and job type. |
permission |
string optional. A permissions string, one of "read", "write", or "manage". Lists only jobs for which the current user has that permission. |
scheduled |
boolean optional. If the item is scheduled. |
boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items. | |
archived |
string optional. The archival status of the requested item(s). |
author |
string optional. If specified, return items from any of these authors. It accepts a comma-separated list of user IDs. |
limit |
integer optional. Number of results to return. Defaults to its maximum of 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. |
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, |
name |
string, |
type |
string, |
fromTemplateId |
integer, |
state |
string, Whether the job is idle, queued, running, cancelled, or failed. |
createdAt |
string, |
updatedAt |
string, |
lastRun |
list, A list containing the following elements:
|
archived |
string, The archival status of the requested item(s). |
author |
list, A list containing the following elements:
|
schedule |
list, A list containing the following elements:
|