templates_list_scripts {civis}

List Script Templates

Description

List Script Templates

Usage

templates_list_scripts(
  hidden = NULL,
  author = NULL,
  category = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

hidden

boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

author

string optional. If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.

category

string optional. A category to filter results by, one of: import, export, enhancement, model, and script

limit

integer optional. Number of results to return. Defaults to 50. Maximum allowed is 1000.

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 name. Must be one of: name, updated_at, created_at.

order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.

Value

An array containing the following fields:

id

integer,

public

boolean, If the template is public or not.

scriptId

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

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.

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.

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.