templates_patch_scripts: Update some attributes of this Script Template

Description Usage Arguments Value

Description

Update some attributes of this Script Template

Usage

1
2
3
4
5
6
7
templates_patch_scripts(
  id,
  name = NULL,
  note = NULL,
  ui_report_id = NULL,
  archived = NULL
)

Arguments

id

integer required.

name

string optional. The name of the template.

note

string optional. A note describing what this template is used for; custom scripts created off this template will display this description.

ui_report_id

integer optional. The id of the report that this template uses.

archived

boolean optional. Whether the template has been archived.

Value

A list containing the following elements:

id

integer,

public

boolean, If the template is public or not.

scriptId

integer, The id of the script that this template uses.

scriptType

string, The type of the template's backing script (e.g SQL, Container, Python, R, JavaScript)

userContext

string, The user context of the script that this template uses.

name

string, The name of the template.

category

string, The category of this template.

note

string, A note describing what this template is used for; custom scripts created off this template will display this description.

createdAt

string,

updatedAt

string,

useCount

integer, The number of uses of this template.

uiReportId

integer, The id of the report that this template uses.

techReviewed

boolean, Whether this template has been audited by Civis for security vulnerability and correctness.

archived

boolean, Whether the template has been archived.

hidden

boolean, The hidden status of the item.


civisanalytics/civis-r documentation built on June 27, 2020, 7:25 a.m.