notes

Creates, updates, deletes, gets or lists a notes resource.

Overview

Name	notes
Type	Resource
Id	pagerduty.incidents.notes

Fields

The following fields are returned by SELECT queries:

list_incident_notes

An array of notes.

Name	Datatype	Description
id	string
channel	object	The means by which this Note was created. Has different formats depending on type.
content	string	The note content
created_at	string (date-time)	The time at which the note was submitted
user	object	The user who created a Note. If a service created this Note the user.type will be "bot_user_reference" and user.summary will list the name of the service rather than the user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_incident_notes	select	id	Accept, Content-Type	List existing notes for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the API Concepts Document Scoped OAuth requires: incidents.read
create_incident_note	insert	id, From, data__note	Accept, Content-Type	Create a new note for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. A maximum of 2000 notes can be added to an incident. For more information see the API Concepts Document Scoped OAuth requires: incidents.write
_list_incident_notes	exec	id	Accept, Content-Type	List existing notes for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the API Concepts Document Scoped OAuth requires: incidents.read

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
From	string (email)	The email address of a valid user associated with the account making the request.
id	string	The ID of the resource.
Accept	string	The Accept header is used as a versioning header.
Content-Type	string

SELECT examples

list_incident_notes

List existing notes for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the API Concepts Document

Scoped OAuth requires: incidents.read

SELECT
id,
channel,
content,
created_at,
user
FROM pagerduty.incidents.notes
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

INSERT examples

create_incident_note

Create a new note for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

A maximum of 2000 notes can be added to an incident.

For more information see the API Concepts Document

Scoped OAuth requires: incidents.write

INSERT INTO pagerduty.incidents.notes (
data__note,
id,
From,
Accept,
Content-Type
)
SELECT 
'{{ note }}' /* required */,
'{{ id }}',
'{{ From }}',
'{{ Accept }}',
'{{ Content-Type }}'
RETURNING
note
;

Manifest

# Description fields are for documentation purposes
- name: notes
  props:
    - name: id
      value: string
      description: Required parameter for the notes resource.
    - name: From
      value: string (email)
      description: Required parameter for the notes resource.
    - name: note
      value: object
    - name: Accept
      value: string
      description: The `Accept` header is used as a versioning header.
    - name: Content-Type
      value: string

Lifecycle Methods

_list_incident_notes

List existing notes for the specified incident.

An incident represents a problem or an issue that needs to be addressed and resolved.

For more information see the API Concepts Document

Scoped OAuth requires: incidents.read

EXEC pagerduty.incidents.notes._list_incident_notes 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;