Skip to main content

templates

Overview

Nametemplates
TypeResource
Idpagerduty.templates.templates

Fields

NameDatatypeDescription
idstring
namestringThe name of the template
descriptionstringDescription of the template
created_by``User/Account object reference of the creator
html_urlstringa URL at which the entity is uniquely displayed in the Web app
selfstringthe API show URL at which the object is accessible
summarystringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
template_typestringThe type of template (status_update is the only supported template at this time)
templated_fieldsobject
typestring
updated_by``User/Account object reference of the updator

Methods

NameAccessible byRequired ParamsDescription
get_templateSELECTidGet a single template on the account

Scoped OAuth requires: templates.read
get_templatesSELECTGet a list of all the template on an account

Scoped OAuth requires: templates.read
create_templateINSERTdata__templateCreate a new template

Scoped OAuth requires: templates.write
delete_templateDELETEidDelete a specific of templates on the account

Scoped OAuth requires: templates.write
_get_templateEXECidGet a single template on the account

Scoped OAuth requires: templates.read
_get_templatesEXECGet a list of all the template on an account

Scoped OAuth requires: templates.read
render_templateEXECidRender a template. This endpoint has a variable request body depending on the template type. For the status_update template type, the caller will provide the incident id, and a status update message.

Scoped OAuth requires: templates.read
update_templateEXECid, data__templateUpdate an existing template

Scoped OAuth requires: templates.write