Points de terminaison d'API REST pour Mains Courantes
Suppression d'une main courante
Suppression d'une main courante existante.
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 /mains_courantes/{main_courante_id}
Détails d'une main courante
Récupération d'une main courante existante.
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 Main Courante contenant les données demandées.
GET /mains_courantes/{main_courante_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
objet string required
Objet de la main courante.
256 max length
date string required
Horodatage de la main courante.
format : date-time 20 min length 50 max length
compte_rendu string required
Contenu de la main courante.
32768 max length
type string required
Type de la main courante.
| Valeurs possibles |
|---|
REUNIONRéunion. |
INTERVENTIONIntervention. |
RCCIRecherche des Causes et des Circonstances de l'Incendie. |
RETEXRetour d'expérience. |
Mise à jour d'une main courante
Mise à jour d'une main courante existante en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.
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
objet string
Objet de la main courante.
256 max length
date string
Horodatage de la main courante.
format : date-time 20 min length 50 max length
compte_rendu string
Contenu de la main courante.
32768 max length
type string
Type de la main courante.
| Valeurs possibles |
|---|
REUNIONRéunion. |
INTERVENTIONIntervention. |
RCCIRecherche des Causes et des Circonstances de l'Incendie. |
RETEXRetour d'expérience. |
Réponses
200 OK
Retourne un Objet Main Courante contenant les données demandées.
POST /mains_courantes/{main_courante_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
objet string required
Objet de la main courante.
256 max length
date string required
Horodatage de la main courante.
format : date-time 20 min length 50 max length
compte_rendu string required
Contenu de la main courante.
32768 max length
type string required
Type de la main courante.
| Valeurs possibles |
|---|
REUNIONRéunion. |
INTERVENTIONIntervention. |
RCCIRecherche des Causes et des Circonstances de l'Incendie. |
RETEXRetour d'expérience. |
Liste paginée des documents
Récupération de la liste des documents.
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 Piece Jointe (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Piece Jointe distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /mains_courantes/{main_courante_id}/documents
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
url string required
Point de stockage du fichier.
format : uri 512 max length
nom string required
Nom du fichier joint.
256 max length
description string required nullable
Description du fichier joint.
8192 max length
type string required
Type de la pièce jointe.
| Valeurs possibles |
|---|
photoPhoto. |
planPlan. |
annexeAnnexe. |
diversDivers. |
rapport de vérification réglementaire après travauxRapport de vérification réglementaire après travaux. |
est_sensible boolean required
Information permettant de savoir si le contenu du document doit être considéré comme sensible par Metarisc.
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 document
Ajout d'un document.
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
url string required
Point de stockage du fichier.
format : uri 512 max length
nom string required
Nom du fichier joint.
256 max length
description string nullable
Description du fichier joint.
8192 max length
type string required
Type de la pièce jointe.
| Valeurs possibles |
|---|
photoPhoto. |
planPlan. |
annexeAnnexe. |
diversDivers. |
rapport de vérification réglementaire après travauxRapport de vérification réglementaire après travaux. |
est_sensible boolean required
Information permettant de savoir si le contenu du document doit être considéré comme sensible par Metarisc.
Réponses
201 OK
Retourne l'Objet Piece Jointe créé.
POST /mains_courantes/{main_courante_id}/documents
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
url string required
Point de stockage du fichier.
format : uri 512 max length
nom string required
Nom du fichier joint.
256 max length
description string required nullable
Description du fichier joint.
8192 max length
type string required
Type de la pièce jointe.
| Valeurs possibles |
|---|
photoPhoto. |
planPlan. |
annexeAnnexe. |
diversDivers. |
rapport de vérification réglementaire après travauxRapport de vérification réglementaire après travaux. |
est_sensible boolean required
Information permettant de savoir si le contenu du document doit être considéré comme sensible par Metarisc.
Liste complète des participants de la main courante
Liste des participants de la main courante.
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 tableau d'Objet Main Courante Affectation. Chaque entrée du tableau constitue un Objet Main Courante Affectation distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /mains_courantes/{main_courante_id}/participants
data array of object required
Liste d'objets.
100 max items
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
utilisateur object required
Utilisateur affecté à la main courante.
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
Ajout d'une participation dans la main courante
Ajoute une participation à une main courante. Vous pouvez affecter plusieurs personnes à la main courante, y compris vous-même.
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
utilisateur_id string required
Identifiant de l'utilisateur à affecter à la main courante.
256 max length
Réponses
201 OK
Retourne l'Objet Main Courante Affectation créé.
POST /mains_courantes/{main_courante_id}/participants
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
utilisateur object required
Utilisateur affecté à la main courante.
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