Notes
interface NotesApi
Functions
Link copied to clipboard
abstract suspend fun addNewNote(resourceType: String, resourceId: Long, postResourceTypeResourceIdNotesRequest: PostResourceTypeResourceIdNotesRequest): PostResourceTypeResourceIdNotesResponse
Add a Resource Note Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes Responses:
Link copied to clipboard
abstract suspend fun deleteNote(resourceType: String, resourceId: Long, noteId: Long): DeleteResourceTypeResourceIdNotesNoteIdResponse
Delete a Resource Note Deletes a Resource Note Responses:
Link copied to clipboard
abstract suspend fun retrieveNote(resourceType: String, resourceId: Long, noteId: Long): GetResourceTypeResourceIdNotesNoteIdResponse
Retrieve a Resource Note Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername Responses:
Link copied to clipboard
abstract suspend fun retrieveNotesByResource(resourceType: String, resourceId: Long): List<GetResourceTypeResourceIdNotesResponse>
Retrieve a Resource's description Retrieves a Resource's Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername Responses:
Link copied to clipboard
abstract suspend fun updateNote(resourceType: String, resourceId: Long, noteId: Long, putResourceTypeResourceIdNotesNoteIdRequest: PutResourceTypeResourceIdNotesNoteIdRequest): PutResourceTypeResourceIdNotesNoteIdResponse
Update a Resource Note Updates a Resource Note Responses: