Points de terminaison d'API REST pour Anomalies
Liste paginée des anomalies types de la bibliothèque DECI
Retourne une liste des anomalies types dans la bibliothèque DECI.
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
code integer
Filtre sur le code de l'anomalie
format : int32 ≥=0 ≤=999999
texte string
Filtre sur le texte de l'anomalie
8192 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: code
| Valeurs possibles |
|---|
codeordre croissant sur code (asc). |
-codeordre décroissant sur code (desc). |
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Anomalie DECI (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Anomalie DECI distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /anomalies
data array of object required
Tableau d'objets contenu dans la page.
100 max items
code integer required
Référence codifiée de l'anomalie.
format : int32 ≥=0 ≤=999999
texte string required
Description de l'anomalie.
8192 max length
indice_de_gravite integer required
L'indice de gravité permet de classifier l'impact d'une anomalie sur la vie d'un PEI.
format : int32 ≥=0 ≤=2
| Valeurs possibles |
|---|
0Réserve. |
1Anomalie. |
2Anomalie bloquante. |
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'une anomalie
Ajout d'une nouvelle anomalie DECI type dans la bibliothèque DECI.
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
code integer required
Référence codifiée de l'anomalie.
format : int32 ≥=0 ≤=999999
texte string required
Description de l'anomalie.
8192 max length
indice_de_gravite integer required
L'indice de gravité permet de classifier l'impact d'une anomalie sur la vie d'un PEI.
format : int32 ≥=0 ≤=2
| Valeurs possibles |
|---|
0Réserve. |
1Anomalie. |
2Anomalie bloquante. |
Réponses
201 OK
Retourne l'Objet Anomalie DECI créé.
POST /anomalies
code integer required
Référence codifiée de l'anomalie.
format : int32 ≥=0 ≤=999999
texte string required
Description de l'anomalie.
8192 max length
indice_de_gravite integer required
L'indice de gravité permet de classifier l'impact d'une anomalie sur la vie d'un PEI.
format : int32 ≥=0 ≤=2
| Valeurs possibles |
|---|
0Réserve. |
1Anomalie. |
2Anomalie bloquante. |
Suppression d'une anomalie type
Suppression d'une anomalie DECI type dans la bibliothèque DECI.
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 /anomalies/{anomalie_id}
Détails d'une anomalie type
Détails d'une anomalie type DECI présente dans la bibliothèque DECI.
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 Anomalie DECI contenant les données demandées.
GET /anomalies/{anomalie_id}
code integer required
Référence codifiée de l'anomalie.
format : int32 ≥=0 ≤=999999
texte string required
Description de l'anomalie.
8192 max length
indice_de_gravite integer required
L'indice de gravité permet de classifier l'impact d'une anomalie sur la vie d'un PEI.
format : int32 ≥=0 ≤=2
| Valeurs possibles |
|---|
0Réserve. |
1Anomalie. |
2Anomalie bloquante. |