Points de terminaison d'API REST pour Enveloppes
Liste paginée des enveloppes
Récupération de la liste des enveloppes selon des critères de recherche.
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
titre string
Filtre sur le titre de l'enveloppe
256 max length
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
sort string
Propriété sur laquelle trier les résultats. L'ordre de tri par défaut est croissant (asc) sauf si la propriété est préfixée par un trait d'union (-), auquel cas l'ordre de tri sera décroissant (desc).
Propriété sur lesquelles les résultats seront triés.
pattern ^-?\w*$ 256 max length default: titre
| Valeurs possibles |
|---|
titreordre croissant sur titre (asc). |
-titreordre décroissant sur titre (desc). |
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Enveloppe (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Enveloppe distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /enveloppes
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
titre string required
Titre de l'enveloppe.
256 max length
nb_dossiers integer required
Nombre de dossiers contenus dans l'enveloppe.
format : int32 ≥=0 ≤=50
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
Créer une enveloppe
Création d'une nouvelle enveloppe.
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 de l'enveloppe.
256 max length
Réponses
201 OK
Retourne l'Objet Enveloppe créé.
POST /enveloppes
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
titre string required
Titre de l'enveloppe.
256 max length
nb_dossiers integer required
Nombre de dossiers contenus dans l'enveloppe.
format : int32 ≥=0 ≤=50
Suppression d'une enveloppe
Suppression d'une enveloppe (cette opération n'impacte pas les dossiers lié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.
Réponses
204 No Content
Retourne une réponse vide.
DELETE /enveloppes/{enveloppe_id}
Détails d'une enveloppe
Récupération de l'ensemble des données d'une enveloppe.
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 Enveloppe contenant les données demandées.
GET /enveloppes/{enveloppe_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
titre string required
Titre de l'enveloppe.
256 max length
nb_dossiers integer required
Nombre de dossiers contenus dans l'enveloppe.
format : int32 ≥=0 ≤=50
Mise à jour d'une enveloppe
Mise à jour d'une nouvelle enveloppe.
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 de l'enveloppe.
256 max length
Réponses
200 OK
Retourne un Objet Enveloppe contenant les données demandées.
PATCH /enveloppes/{enveloppe_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
titre string required
Titre de l'enveloppe.
256 max length
nb_dossiers integer required
Nombre de dossiers contenus dans l'enveloppe.
format : int32 ≥=0 ≤=50