scripts_post_custom_clone {civis} | R Documentation |
Clone this Custom Script
Description
Clone this Custom Script
Usage
scripts_post_custom_clone(
id,
clone_schedule = NULL,
clone_triggers = NULL,
clone_notifications = NULL
)
Arguments
id |
integer required. The ID for the script. |
clone_schedule |
boolean optional. If true, also copy the schedule to the new script. |
clone_triggers |
boolean optional. If true, also copy the triggers to the new script. |
clone_notifications |
boolean optional. If true, also copy the notifications to the new script. |
Value
A list containing the following elements:
id |
integer, The ID for the script. |
fromTemplateAliases |
array, An array containing the following fields:
|
name |
string, The name of the script. |
type |
string, The type of the script (e.g Custom) |
backingScriptType |
string, The type of the script backing this template (e.g Python) |
createdAt |
string, The time this script was created. |
updatedAt |
string, The time the script was last updated. |
author |
list, A list containing the following elements:
|
state |
string, The status of the script's last run. |
finishedAt |
string, The time that the script's last run finished. |
category |
string, |
projects |
array, An array containing the following fields:
|
parentId |
integer, The ID of the parent job that will trigger this script |
params |
array, An array containing the following fields:
|
arguments |
list, Parameter-value pairs to use when running this script. Only settable if this script has defined parameters. |
isTemplate |
boolean, Whether others scripts use this one as a template. |
publishedAsTemplateId |
integer, The ID of the template that this script is backing. |
fromTemplateId |
integer, The ID of the template script. |
uiReportUrl |
integer, The url of the custom HTML. |
uiReportId |
integer, The id of the report with the custom HTML. |
uiReportProvideAPIKey |
boolean, Whether the ui report requests an API Key from the report viewer. |
templateScriptName |
string, The name of the template script. |
templateNote |
string, The template's note. |
remoteHostId |
integer, The remote host ID that this script will connect to. |
credentialId |
integer, The credential that this script will use. |
codePreview |
string, The code that this script will run with arguments inserted. |
schedule |
list, A list containing the following elements:
|
notifications |
list, A list containing the following elements:
|
runningAs |
list, A list containing the following elements:
|
timeZone |
string, The time zone of this script. |
lastRun |
list, A list containing the following elements:
|
myPermissionLevel |
string, Your permission level on the object. One of "read", "write", or "manage". |
hidden |
boolean, The hidden status of the item. |
archived |
string, The archival status of the requested item(s). |
targetProjectId |
integer, Target project to which script outputs will be added. |
lastSuccessfulRun |
list, A list containing the following elements:
|
requiredResources |
list, A list containing the following elements:
|
partitionLabel |
string, The partition label used to run this object. Only applicable for jobs using Docker. |
runningAsId |
integer, The ID of the runner of this script. |