Points de terminaison d'API REST pour Documents
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 /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
Suppression d'un document
Suppression d'un document 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 /documents/{document_id}
Détails d'un document
Récupération 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.
Réponses
200 OK
Retourne un Objet Piece Jointe contenant les données demandées.
GET /documents/{document_id}
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.
Mise à jour d'un document
Mise à jour d'un document existant 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
nom string
Nom du fichier joint.
256 max length
description string nullable
Description du fichier joint.
8192 max length
type string
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. |
Réponses
200 OK
Retourne un Objet Piece Jointe contenant les données demandées.
POST /documents/{document_id}
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.