Points de terminaison d'API REST pour Notifications
Liste paginée des notifications
Récupération des détails de toutes les notifications existantes pour l'utilisateur connecté.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Paramètres supplémentaires
page integer
Le numéro de la page de résultats demandé.
format : int32 ≥=1 ≤=999999 default: 1
per_page integer
Limite le nombre d'objets retournés par une page. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
format : int32 ≥=1 ≤=100 default: 10
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Notification (en respectant les limites de pagination). Chaque entrée du tableau constitue un Notification distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /notifications
data array of object required
Tableau d'objets contenu dans la page.
100 max items
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
title string required
Titre de la notification.
256 max length
message string required
Contenu de la notification.
8192 max length
type string required
Type de la notification. Le type correspond à un événement particulier dans le système qui déclenche la création de la notification.
| Valeurs possibles |
|---|
infoNotification d'information. |
contexte object required
Ensemble de paires clé-valeur que vous pouvez attacher à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l'objet dans un format structuré.
date_creation string required
Date de déclenchement de la notification.
format : date-time 20 min length 50 max length
date_de_lecture string required nullable
Date à laquelle l'utilisateur a lu la notification.
format : date-time 20 min length 50 max length
utilisateur object required
Utilisateur cible de la notification.
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
meta object required
Métadonnées de la pagination.
pagination object required
Ensemble d'informations liées à une réponse paginée.
total integer required
Nombre total d'objets.
format : int32 ≥=0 ≤=999999
count integer required
Nombre d'objets contenu dans la page courante.
format : int32 ≥=0 ≤=999999
per_page integer required
Nombre d'objets pouvant être retournés par une page
format : int32 ≥=1 ≤=100
current_page integer required
Numéro de la page courante.
format : int32 ≥=1 ≤=999999
total_pages integer required
Nombres de pages disponibles.
format : int32 ≥=1 ≤=999999
Déclenchement d'une notification
Création d'une notification.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Paramètres du corps de la requête
title string required
Titre de la notification.
256 max length
message string required
Contenu de la notification.
8192 max length
type string required
Type de la notification. Le type correspond à un événement particulier dans le système qui déclenche la création de la notification.
| Valeurs possibles |
|---|
infoNotification d'information. |
contexte object
Ensemble de paires clé-valeur que vous pouvez attacher à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l'objet dans un format structuré.
utilisateur_id string required
Identifiant de l'utilisateur cible de la notification.
256 max length
Réponses
201 created
Retourne l'Notification créé.
POST /notifications
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
title string required
Titre de la notification.
256 max length
message string required
Contenu de la notification.
8192 max length
type string required
Type de la notification. Le type correspond à un événement particulier dans le système qui déclenche la création de la notification.
| Valeurs possibles |
|---|
infoNotification d'information. |
contexte object required
Ensemble de paires clé-valeur que vous pouvez attacher à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l'objet dans un format structuré.
date_creation string required
Date de déclenchement de la notification.
format : date-time 20 min length 50 max length
date_de_lecture string required nullable
Date à laquelle l'utilisateur a lu la notification.
format : date-time 20 min length 50 max length
utilisateur object required
Utilisateur cible de la notification.
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
Suppression d'une notification
Suppression d'une notification correspondante à l'id donné.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Réponses
204 No Content
Retourne une réponse vide.
DELETE /notifications/{notification_id}
Récupération des détails d'une notification
Récupération des détails d'une notification correspondante à l'id donné.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Réponses
200 OK
Retourne un Notification contenant les données demandées.
GET /notifications/{notification_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
title string required
Titre de la notification.
256 max length
message string required
Contenu de la notification.
8192 max length
type string required
Type de la notification. Le type correspond à un événement particulier dans le système qui déclenche la création de la notification.
| Valeurs possibles |
|---|
infoNotification d'information. |
contexte object required
Ensemble de paires clé-valeur que vous pouvez attacher à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l'objet dans un format structuré.
date_creation string required
Date de déclenchement de la notification.
format : date-time 20 min length 50 max length
date_de_lecture string required nullable
Date à laquelle l'utilisateur a lu la notification.
format : date-time 20 min length 50 max length
utilisateur object required
Utilisateur cible de la notification.
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
Marquer la notification comme lue
Permet de marquer la notification donnée comme lue par l'utilisateur.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Réponses
200 OK
Retourne un Notification contenant les données demandées.
POST /notifications/{notification_id}/marquer_comme_lue
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
title string required
Titre de la notification.
256 max length
message string required
Contenu de la notification.
8192 max length
type string required
Type de la notification. Le type correspond à un événement particulier dans le système qui déclenche la création de la notification.
| Valeurs possibles |
|---|
infoNotification d'information. |
contexte object required
Ensemble de paires clé-valeur que vous pouvez attacher à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l'objet dans un format structuré.
date_creation string required
Date de déclenchement de la notification.
format : date-time 20 min length 50 max length
date_de_lecture string required nullable
Date à laquelle l'utilisateur a lu la notification.
format : date-time 20 min length 50 max length
utilisateur object required
Utilisateur cible de la notification.
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length