Notifications

Lister ses notifications

Changed on

Renvoie la liste paginée des notifications in-app de l'utilisateur courant, les plus récentes en premier.

get/api/v2/notifications

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/auth, token URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/token)
    • API key in header x-refapp-token

Query parameters

pageinteger

Numéro de page, à partir de zéro

pageSizeinteger
Example:15

Nombre de résultats par page, 0 pour supprimer la pagination

sortBystring
Example:label

Champ utilisé pour le tri

order'asc' | 'desc'
Example:asc

Ordre de tri

isReadboolean

Filtrer sur l'état de lecture : false pour les notifications non lues, true pour les notifications lues. Sans ce paramètre, les deux états sont renvoyés.

Response

Liste paginée des notifications

totalnumber required

Total number of items

Example response

{
  "total": 100
}

Changes

  • 4247f2cfc4b7Revision changes
    • breaking

      for the query request parameter page, the type changed from number to integer

    • breaking

      for the query request parameter pageSize, the type changed from number to integer

    • info

      added the new optional query request parameter isRead

  • 8765538f8a4dRevision changes
    • warning

      added the new technology_end_of_life enum value to the ////// response property for the response status