jobs_put_archive: Update the archive status of this object

In civis: R Client for the 'Civis Platform API'

Update the archive status of this object

Description

Update the archive status of this object

Usage

jobs_put_archive(id, status)

Arguments

id	integer required. The ID of the object.
status	boolean required. The desired archived status of the object.

Value

A list containing the following elements:

id	integer,
name	string,
type	string,
fromTemplateId	integer,
state	string, Whether the job is idle, queued, running, cancelled, or failed.
createdAt	string,
updatedAt	string,
runs	array, 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.
lastRun	list, A list containing the following elements: 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.
hidden	boolean, The hidden status of the item.
archived	string, The archival status of the requested item(s).
author	list, A list containing the following elements: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.
myPermissionLevel	string, Your permission level on the object. One of "read", "write", or "manage".
successEmailSubject	string,
successEmailBody	string,
runningAsUser	string,
runByUser	string,
schedule	list, A list containing the following elements: scheduled boolean, If the item is scheduled. scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth scheduledHours array, Hours of the day it is scheduled on. scheduledMinutes array, Minutes of the day it is scheduled on. scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes. scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.

civis documentation built on April 1, 2023, 12:01 a.m.