templates_post_reports {civis}

Create a Report Template

Description

Create a Report Template

Usage

templates_post_reports(
  name,
  code_body,
  category = NULL,
  archived = NULL,
  provide_api_key = NULL,
  hidden = NULL
)

Arguments

name

string required. The name of the template.

code_body

string required. The code for the Template body.

category

string optional. The category of this report template. Can be left blank. Acceptable values are: dataset-viz

archived

boolean optional. Whether the template has been archived.

provide_api_key

boolean optional. Whether reports based on this template request an API Key from the report viewer.

hidden

boolean optional. The hidden status of the item.

Value

A list containing the following elements:

id

integer,

name

string, The name of the template.

category

string, The category of this report template. Can be left blank. Acceptable values are: dataset-viz

createdAt

string,

updatedAt

string,

useCount

integer, The number of uses of this template.

archived

boolean, Whether the template has been archived.

techReviewed

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

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.

authCodeUrl

string, A URL to the template's stored code body.

provideAPIKey

boolean, Whether reports based on this template request an API Key from the report viewer.

hidden

boolean, The hidden status of the item.