Notes Module API

API reference for note creation and retrieval endpoints.

BriteCore v2 Notes API endpoint wrappers.

Provides:

retrieve_notes – Retrieve paginated, filterable notes for any entity ID.

britecore_sdk.api.api_calls.v2.notes.new_note(payload=None, **kwargs)[source]

Create a new note record for an entity.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.notes.retrieve_notes(entity_id, pageSize=1000, searchString=None, aggregateAll=False, advSearch=False, filterAlerts=False, filterUserGen=False, orderBy='', page=0, ascending=False, note_type='', filterExcludeAlerts=False, filterSystemNotesOnly=False, **kwargs)[source]

Retrieve notes for an entity with filtering and pagination controls.

POST /api/v2/notes/retrieveNotes

Parameters:

  • entity_id (str)

  • pageSize (int | None)

  • searchString (str | None)

  • aggregateAll (bool | None)

  • advSearch (bool | None)

  • filterAlerts (bool | None)

  • filterUserGen (bool | None)

  • orderBy (str | None)

  • page (int | None)

  • ascending (bool | None)

  • note_type (str | None)

  • filterExcludeAlerts (bool | None)

  • filterSystemNotesOnly (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.notes.store_note(payload=None, **kwargs)[source]

Persist updates for an existing note record.

Parameters:
Return type:

Any