Points de terminaison d'API REST pour Feed
Liste paginée des messages du fil d’actualite
Récupération d'une liste de message composant un flux d'activité 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 Success
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Feed Message (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Feed Message distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /feed
data array of object required
Tableau d'objets contenu dans la page.
100 max items
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
Ajoute un message dans le feed
Ajoute un message dans le feed général.
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
titre string required
Titre du message.
256 max length
type string required
Type du message.
| Valeurs possibles |
|---|
texteMessage de type texte. |
liste_peiMessage contenant une liste de PEI. |
message_utilisateurMessage rédigé par un utilisateur. |
texte string required
Contenu du message.
32768 max length
Réponses
201 OK
Retourne l'Objet FeedMessage MessageUtilisateur créé.
POST /feed
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
titre string required
Titre du message.
256 max length
date_de_creation string required
Date de création du message.
format : date-time 20 min length 50 max length
type string required
Type du message.
| Valeurs possibles |
|---|
texteMessage de type texte. |
liste_peiMessage contenant une liste de PEI. |
message_utilisateurMessage rédigé par un utilisateur. |
texte string required
Contenu du message.
32768 max length
redacteur object required
Utilisateur ayant rédigé le message.
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'un message dans le feed
Suppression d'un message existant.
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 /feed/{message_id}
Modification d'un message dans le feed
Modifier un message dans le feed général.
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
titre string
Titre du message.
256 max length
texte string
Contenu du message.
32768 max length
Réponses
200 OK
Retourne un Objet FeedMessage MessageUtilisateur contenant les données demandées.
PATCH /feed/{message_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
titre string required
Titre du message.
256 max length
date_de_creation string required
Date de création du message.
format : date-time 20 min length 50 max length
type string required
Type du message.
| Valeurs possibles |
|---|
texteMessage de type texte. |
liste_peiMessage contenant une liste de PEI. |
message_utilisateurMessage rédigé par un utilisateur. |
texte string required
Contenu du message.
32768 max length
redacteur object required
Utilisateur ayant rédigé le message.
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