notes

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

Overview

Name	notes
Type	Resource
Id	firebase.firebasecrashlytics.notes

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Output only. Identifier. Format: "projects/{project}/apps/app/issues/{issue}/notes/{note}".
author	string	Output only. The email of the author of the note.
body	string	Immutable. The body of the note.
createTime	string (google-datetime)	Output only. Time when the note was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, appsId, issuesId	pageToken, pageSize	List all notes for a certain issue, sorted in descending order by timestamp.
create	insert	projectsId, appsId, issuesId		Create a new note for an issue.
delete	delete	projectsId, appsId, issuesId, notesId		Delete a note by its name.

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
appsId	string
issuesId	string
notesId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list

List all notes for a certain issue, sorted in descending order by timestamp.

SELECT
name,
author,
body,
createTime
FROM firebase.firebasecrashlytics.notes
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND issuesId = '{{ issuesId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Create a new note for an issue.

INSERT INTO firebase.firebasecrashlytics.notes (
data__body,
projectsId,
appsId,
issuesId
)
SELECT 
'{{ body }}',
'{{ projectsId }}',
'{{ appsId }}',
'{{ issuesId }}'
RETURNING
name,
author,
body,
createTime
;

Manifest

# Description fields are for documentation purposes
- name: notes
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the notes resource.
  - name: appsId
    value: "{{ appsId }}"
    description: Required parameter for the notes resource.
  - name: issuesId
    value: "{{ issuesId }}"
    description: Required parameter for the notes resource.
  - name: body
    value: "{{ body }}"
    description: |
      Immutable. The body of the note.

DELETE examples

delete

Delete a note by its name.

DELETE FROM firebase.firebasecrashlytics.notes
WHERE projectsId = '{{ projectsId }}' --required
AND appsId = '{{ appsId }}' --required
AND issuesId = '{{ issuesId }}' --required
AND notesId = '{{ notesId }}' --required
;