client.templates.patch_reports

A method of the Templates endpoint.

patch_reports(id: int, *, name: str = None, category: str = None, archived: bool = None, code_body: str = None, provide_api_key: bool = None) → Response

Update some attributes of this Report Template

API URL: PATCH /templates/reports/{id}

import civis
client = civis.APIClient()
response = client.templates.patch_reports(...)

Parameters:

idint

namestr, optional

The name of the template.

categorystr, optional

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

archivedbool, optional

Whether the template has been archived.

code_bodystr, optional

The code for the Template body.

provide_api_keybool, optional

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

Returns:

civis.Response

• id : int

• namestr

  The name of the template.

• categorystr

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

• created_at : str (time)

• updated_at : str (time)

• use_countint

  The number of uses of this template.

• archivedbool

  Whether the template has been archived.

• tech_reviewedbool

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

• authorcivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• auth_code_urlstr

  A URL to the template’s stored code body.

• provide_api_keybool

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

• hiddenbool

  The hidden status of the item.