Points de terminaison d'API REST pour Prescriptions
Liste paginée d'exploration des prescriptions
Cette opération permet d'explorer les prescriptions en fonction de leur emplacement dans la structure de répertoires. Il est possible de filtrer les prescriptions en fonction de leur contenu ou de références aux supports réglementaires. Les résultats retournés peuvent être des prescriptions ou des chemins (répertoires). Les résultats sont trié de manière à afficher en premier les répertoires (chemins) puis les prescriptions.
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
chemin string
Chemin dans lequel explorer les prescriptions
pattern ^\/(?:[a-zA-Zà-úÀ-Ú0-9\s\/\-])*$ 255 max length
contenu string
Filtre sur le contenu de la prescription
8192 max length
support_reglementaire_reference string
Filtre sur les références des supports réglementaires de la prescription
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
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Prescription Explore Result (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Prescription Explore Result distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /prescriptions/explore
data array of object required
Tableau d'objets contenu dans la page.
100 max items
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
Liste paginée des prescriptions
Liste des prescriptions.
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
contenu string
Filtre sur le contenu de la prescription
8192 max length
support_reglementaire_reference string
Filtre sur les références des supports réglementaires de la prescription
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
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Prescription (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Prescription distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /prescriptions
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
contenu string required
Contenu de la prescription.
8192 max length
type string required nullable
Classement de la prescription.
| Valeurs possibles |
|---|
liee_a_l_exploitationPrescription liée à l'exploitation. |
liee_a_l_ameliorationPrescription liée à l'amélioration. |
rappel_reglementaireRappel réglementaire. |
supports_reglementaires array of object required
Les supports réglementaires de la prescription.
50 max items
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
nature string required
Nature du support réglementaire.
| Valeurs possibles |
|---|
arreteArrêté. |
articleArticle. |
arretes_prefectorauxEnsemble d'arrêtés préfectoraux. |
articlesEnsemble d'articles. |
guidesGuides. |
local_autre_texteTexte réglementaire local. |
doctrineDoctrine. |
textes_nationaux_autre_texteTexte réglementaire national. |
avis_ccsAvis du Conseil Consultatif de la Sécurité. |
instructions_techniquesInstructions techniques. |
legifrance_cid string required nullable
Le CID est l’identifiant commun à l’ensemble des versions d’un objet Legifrance (article, section, texte). Si le CID est renseigné, alors ce support réglementaire est sourcé depuis Legifrance.
256 max length
contenu string
Contenu du support réglementaire.
8192 max length
titre string
Titre du contenu réglementaire.
512 max length
etat string required
Etat juridique d’un support réglementaire.
| Valeurs possibles |
|---|
en_vigueurLe support réglementaire est en vigueur. |
reference string required
Une chaîne de caractères arbitraire rattachée à l'objet. Utile pour rechercher le support réglementaire.
256 max length
chemins array of string required
Chemins de la prescription. Emplacements dans lesquels on peut trouver la prescription dans la structure de répertoires (mode exploration). Le nombre de niveaux dans le chemin est limité à 10.
10 max items default: /
string
pattern ^\/(?:[a-zA-Zà-úÀ-Ú0-9\s\/\-])*$ 255 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
Ajout d'une prescription type
Ajout d'une nouvelle prescription type dans la bibliothèque.
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
contenu string required
Contenu de la prescription.
8192 max length
type string
Classement de la prescription.
| Valeurs possibles |
|---|
liee_a_l_exploitationPrescription liée à l'exploitation. |
liee_a_l_ameliorationPrescription liée à l'amélioration. |
rappel_reglementaireRappel réglementaire. |
supports_reglementaires_id array of string
Les identifiants des supports réglementaires de la prescription.
50 max items
string
format : uuid 36 fixed length
chemins array of string
Chemins de la prescription. Emplacements dans lesquels on peut trouver la prescription dans la structure de répertoires (mode exploration). Le nombre de niveaux dans le chemin est limité à 10.
10 max items default: /
string
pattern ^\/(?:[a-zA-Zà-úÀ-Ú0-9\s\/\-])*$ 255 max length
Réponses
200 OK
Retourne un Objet Prescription contenant les données demandées.
POST /prescriptions
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
contenu string required
Contenu de la prescription.
8192 max length
type string required nullable
Classement de la prescription.
| Valeurs possibles |
|---|
liee_a_l_exploitationPrescription liée à l'exploitation. |
liee_a_l_ameliorationPrescription liée à l'amélioration. |
rappel_reglementaireRappel réglementaire. |
supports_reglementaires array of object required
Les supports réglementaires de la prescription.
50 max items
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
nature string required
Nature du support réglementaire.
| Valeurs possibles |
|---|
arreteArrêté. |
articleArticle. |
arretes_prefectorauxEnsemble d'arrêtés préfectoraux. |
articlesEnsemble d'articles. |
guidesGuides. |
local_autre_texteTexte réglementaire local. |
doctrineDoctrine. |
textes_nationaux_autre_texteTexte réglementaire national. |
avis_ccsAvis du Conseil Consultatif de la Sécurité. |
instructions_techniquesInstructions techniques. |
legifrance_cid string required nullable
Le CID est l’identifiant commun à l’ensemble des versions d’un objet Legifrance (article, section, texte). Si le CID est renseigné, alors ce support réglementaire est sourcé depuis Legifrance.
256 max length
contenu string
Contenu du support réglementaire.
8192 max length
titre string
Titre du contenu réglementaire.
512 max length
etat string required
Etat juridique d’un support réglementaire.
| Valeurs possibles |
|---|
en_vigueurLe support réglementaire est en vigueur. |
reference string required
Une chaîne de caractères arbitraire rattachée à l'objet. Utile pour rechercher le support réglementaire.
256 max length
chemins array of string required
Chemins de la prescription. Emplacements dans lesquels on peut trouver la prescription dans la structure de répertoires (mode exploration). Le nombre de niveaux dans le chemin est limité à 10.
10 max items default: /
string
pattern ^\/(?:[a-zA-Zà-úÀ-Ú0-9\s\/\-])*$ 255 max length
Suppression d'une prescription type
Suppression d'une prescription type de la bibliothèque.
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 /prescriptions/{prescription_id}
Détails d'une prescription type
Récupération des détails d'une prescription dans la bibliothèque.
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 Prescription contenant les données demandées.
GET /prescriptions/{prescription_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
contenu string required
Contenu de la prescription.
8192 max length
type string required nullable
Classement de la prescription.
| Valeurs possibles |
|---|
liee_a_l_exploitationPrescription liée à l'exploitation. |
liee_a_l_ameliorationPrescription liée à l'amélioration. |
rappel_reglementaireRappel réglementaire. |
supports_reglementaires array of object required
Les supports réglementaires de la prescription.
50 max items
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
nature string required
Nature du support réglementaire.
| Valeurs possibles |
|---|
arreteArrêté. |
articleArticle. |
arretes_prefectorauxEnsemble d'arrêtés préfectoraux. |
articlesEnsemble d'articles. |
guidesGuides. |
local_autre_texteTexte réglementaire local. |
doctrineDoctrine. |
textes_nationaux_autre_texteTexte réglementaire national. |
avis_ccsAvis du Conseil Consultatif de la Sécurité. |
instructions_techniquesInstructions techniques. |
legifrance_cid string required nullable
Le CID est l’identifiant commun à l’ensemble des versions d’un objet Legifrance (article, section, texte). Si le CID est renseigné, alors ce support réglementaire est sourcé depuis Legifrance.
256 max length
contenu string
Contenu du support réglementaire.
8192 max length
titre string
Titre du contenu réglementaire.
512 max length
etat string required
Etat juridique d’un support réglementaire.
| Valeurs possibles |
|---|
en_vigueurLe support réglementaire est en vigueur. |
reference string required
Une chaîne de caractères arbitraire rattachée à l'objet. Utile pour rechercher le support réglementaire.
256 max length
chemins array of string required
Chemins de la prescription. Emplacements dans lesquels on peut trouver la prescription dans la structure de répertoires (mode exploration). Le nombre de niveaux dans le chemin est limité à 10.
10 max items default: /
string
pattern ^\/(?:[a-zA-Zà-úÀ-Ú0-9\s\/\-])*$ 255 max length
Mettre à jour une prescription
Modification d'une prescription 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
contenu string
Contenu de la prescription.
8192 max length
type string
Classement de la prescription.
| Valeurs possibles |
|---|
liee_a_l_exploitationPrescription liée à l'exploitation. |
liee_a_l_ameliorationPrescription liée à l'amélioration. |
rappel_reglementaireRappel réglementaire. |
supports_reglementaires_id array of string
Les identifiants des supports réglementaires de la prescription.
50 max items
string
format : uuid 36 fixed length
chemins array of string
Chemins de la prescription. Emplacements dans lesquels on peut trouver la prescription dans la structure de répertoires (mode exploration). Le nombre de niveaux dans le chemin est limité à 10.
10 max items default: /
string
pattern ^\/(?:[a-zA-Zà-úÀ-Ú0-9\s\/\-])*$ 255 max length
Réponses
200 OK
Retourne un Objet Prescription contenant les données demandées.
PATCH /prescriptions/{prescription_id}
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
contenu string required
Contenu de la prescription.
8192 max length
type string required nullable
Classement de la prescription.
| Valeurs possibles |
|---|
liee_a_l_exploitationPrescription liée à l'exploitation. |
liee_a_l_ameliorationPrescription liée à l'amélioration. |
rappel_reglementaireRappel réglementaire. |
supports_reglementaires array of object required
Les supports réglementaires de la prescription.
50 max items
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
nature string required
Nature du support réglementaire.
| Valeurs possibles |
|---|
arreteArrêté. |
articleArticle. |
arretes_prefectorauxEnsemble d'arrêtés préfectoraux. |
articlesEnsemble d'articles. |
guidesGuides. |
local_autre_texteTexte réglementaire local. |
doctrineDoctrine. |
textes_nationaux_autre_texteTexte réglementaire national. |
avis_ccsAvis du Conseil Consultatif de la Sécurité. |
instructions_techniquesInstructions techniques. |
legifrance_cid string required nullable
Le CID est l’identifiant commun à l’ensemble des versions d’un objet Legifrance (article, section, texte). Si le CID est renseigné, alors ce support réglementaire est sourcé depuis Legifrance.
256 max length
contenu string
Contenu du support réglementaire.
8192 max length
titre string
Titre du contenu réglementaire.
512 max length
etat string required
Etat juridique d’un support réglementaire.
| Valeurs possibles |
|---|
en_vigueurLe support réglementaire est en vigueur. |
reference string required
Une chaîne de caractères arbitraire rattachée à l'objet. Utile pour rechercher le support réglementaire.
256 max length
chemins array of string required
Chemins de la prescription. Emplacements dans lesquels on peut trouver la prescription dans la structure de répertoires (mode exploration). Le nombre de niveaux dans le chemin est limité à 10.
10 max items default: /
string
pattern ^\/(?:[a-zA-Zà-úÀ-Ú0-9\s\/\-])*$ 255 max length