Points de terminaison d'API REST pour Evenements
Liste paginée des événements
Récupération des détails de tous les événements calendaires existants.
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
period string
La période pendant laquelle l'événement se déroule.
pattern ^(.*)\/(.*)$ 21 min length 100 max length
subject_id string
L'identifiant du sujet de l'événement. Ce filtre est à utiliser conjointement avec le paramètre type.
format : uuid 36 fixed length
type string
Le type d'événement.
Type de l'événement.
| Valeurs possibles |
|---|
DEFAUTÉvénement par défaut. |
RECONNAISSANCE_OPERATIONNELLE_ANNUELLEReconnaissance opérationnelle annuelle. |
VISITE_PERIODIQUEVisite périodique. |
COMMISSION_SECURITECommission de sécurité. |
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'Objet Evenement (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Evenement distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /evenements
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 l'événement.
256 max length
type string required
Type de l'événement.
| Valeurs possibles |
|---|
DEFAUTÉvénement par défaut. |
RECONNAISSANCE_OPERATIONNELLE_ANNUELLEReconnaissance opérationnelle annuelle. |
VISITE_PERIODIQUEVisite périodique. |
COMMISSION_SECURITECommission de sécurité. |
description string required nullable
Description de l'événement.
8192 max length
date_debut string required
Date de début de l'événement.
format : date-time 20 min length 50 max length
date_fin string required
Date de fin de l'événement.
format : date-time 20 min length 50 max length
subject object required
Sujet de l'événement.
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
Ajout d'un événement
Création d'un événement.
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 l'événement.
256 max length
type string required
Type de l'événement.
| Valeurs possibles |
|---|
DEFAUTÉvénement par défaut. |
RECONNAISSANCE_OPERATIONNELLE_ANNUELLEReconnaissance opérationnelle annuelle. |
VISITE_PERIODIQUEVisite périodique. |
COMMISSION_SECURITECommission de sécurité. |
description string required
Description de l'événement.
8192 max length
date_debut string required
Date de début de l'événement.
format : date-time 20 min length 50 max length
date_fin string required
Date de fin de l'événement.
format : date-time 20 min length 50 max length
Réponses
201 created
Retourne l'Objet Evenement créé.
POST /evenements
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
title string required
Titre de l'événement.
256 max length
type string required
Type de l'événement.
| Valeurs possibles |
|---|
DEFAUTÉvénement par défaut. |
RECONNAISSANCE_OPERATIONNELLE_ANNUELLEReconnaissance opérationnelle annuelle. |
VISITE_PERIODIQUEVisite périodique. |
COMMISSION_SECURITECommission de sécurité. |
description string required nullable
Description de l'événement.
8192 max length
date_debut string required
Date de début de l'événement.
format : date-time 20 min length 50 max length
date_fin string required
Date de fin de l'événement.
format : date-time 20 min length 50 max length
subject object required
Sujet de l'événement.
Suppression d'un événement
Suppression d'un événement.
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 /evenements/{evenement_id}
Récupération des détails d'un événement
Récupération des détails d'un événement correspondant à 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 Objet Evenement contenant les données demandées.
GET /evenements/{evenement_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
title string required
Titre de l'événement.
256 max length
type string required
Type de l'événement.
| Valeurs possibles |
|---|
DEFAUTÉvénement par défaut. |
RECONNAISSANCE_OPERATIONNELLE_ANNUELLEReconnaissance opérationnelle annuelle. |
VISITE_PERIODIQUEVisite périodique. |
COMMISSION_SECURITECommission de sécurité. |
description string required nullable
Description de l'événement.
8192 max length
date_debut string required
Date de début de l'événement.
format : date-time 20 min length 50 max length
date_fin string required
Date de fin de l'événement.
format : date-time 20 min length 50 max length
subject object required
Sujet de l'événement.
Liste paginée des utilisateurs liés à un événement
Récupération d'une liste paginée d'utilisateurs liés à un événement calendaire.
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'Objet Utilisateur (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Utilisateur distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /evenements/{evenement_id}/utilisateurs
data array of object required
Tableau d'objets contenu dans la page.
100 max items
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