Points de terminaison d'API REST pour Supports Reglementaires

PaginateSupportsReglementaires

Liste paginée des supports réglementaires

Liste des supports réglementaires.

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 du support réglementaire

8192 max length

reference string

Filtre sur la référence du support réglementaire

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 Support Réglementaire (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Support Réglementaire distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.

GET /supports_reglementaires

Schéma de la réponse

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

nature string required

Nature du support réglementaire.

Valeurs possibles
`arrete` Arrêté.
`article` Article.
`arretes_prefectoraux` Ensemble d'arrêtés préfectoraux.
`articles` Ensemble d'articles.
`guides` Guides.
`local_autre_texte` Texte réglementaire local.
`doctrine` Doctrine.
`textes_nationaux_autre_texte` Texte réglementaire national.
`avis_ccs` Avis du Conseil Consultatif de la Sécurité.
`instructions_techniques` Instructions 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_vigueur` Le 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

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

PostSupportsReglementaires

Ajout d'un support réglementaire

Ajouter un support réglementaire.

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

nature string required

Nature du support réglementaire.

Valeurs possibles
`arrete` Arrêté.
`article` Article.
`arretes_prefectoraux` Ensemble d'arrêtés préfectoraux.
`articles` Ensemble d'articles.
`guides` Guides.
`local_autre_texte` Texte réglementaire local.
`doctrine` Doctrine.
`textes_nationaux_autre_texte` Texte réglementaire national.
`avis_ccs` Avis du Conseil Consultatif de la Sécurité.
`instructions_techniques` Instructions techniques.

legifrance_cid string

256 max length

contenu string required

Contenu du support réglementaire.

8192 max length

titre string required

Titre du contenu réglementaire.

512 max length

etat string required

Etat juridique d’un support réglementaire.

Valeurs possibles
`en_vigueur` Le 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

Réponses

200 OK

Retourne un Objet Support Réglementaire contenant les données demandées.

POST /supports_reglementaires

Schéma de la réponse

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

nature string required

Nature du support réglementaire.

Valeurs possibles
`arrete` Arrêté.
`article` Article.
`arretes_prefectoraux` Ensemble d'arrêtés préfectoraux.
`articles` Ensemble d'articles.
`guides` Guides.
`local_autre_texte` Texte réglementaire local.
`doctrine` Doctrine.
`textes_nationaux_autre_texte` Texte réglementaire national.
`avis_ccs` Avis du Conseil Consultatif de la Sécurité.
`instructions_techniques` Instructions techniques.

legifrance_cid string required nullable

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_vigueur` Le 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

DeleteSupportReglementaireSupportsReglementaires

Suppression d'un support réglementaire

Suppression d'un support réglementaire.

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 /supports_reglementaires/{support_reglementaire_id}

GetSupportReglementaireSupportsReglementaires

Détails d'un support réglementaire

Récupération des détails d'un support réglementaire.

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 Support Réglementaire contenant les données demandées.

GET /supports_reglementaires/{support_reglementaire_id}

Schéma de la réponse

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

nature string required

Nature du support réglementaire.

Valeurs possibles
`arrete` Arrêté.
`article` Article.
`arretes_prefectoraux` Ensemble d'arrêtés préfectoraux.
`articles` Ensemble d'articles.
`guides` Guides.
`local_autre_texte` Texte réglementaire local.
`doctrine` Doctrine.
`textes_nationaux_autre_texte` Texte réglementaire national.
`avis_ccs` Avis du Conseil Consultatif de la Sécurité.
`instructions_techniques` Instructions techniques.

legifrance_cid string required nullable

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_vigueur` Le 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

PatchSupportReglementaireSupportsReglementaires

Mettre à jour d'un support réglementaire

Modification d'un support réglementaire 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

nature string

Nature du support réglementaire.

Valeurs possibles
`arrete` Arrêté.
`article` Article.
`arretes_prefectoraux` Ensemble d'arrêtés préfectoraux.
`articles` Ensemble d'articles.
`guides` Guides.
`local_autre_texte` Texte réglementaire local.
`doctrine` Doctrine.
`textes_nationaux_autre_texte` Texte réglementaire national.
`avis_ccs` Avis du Conseil Consultatif de la Sécurité.
`instructions_techniques` Instructions techniques.

contenu string

Contenu du support réglementaire.

8192 max length

titre string

Titre du contenu réglementaire.

512 max length

etat string

Etat juridique d’un support réglementaire.

Valeurs possibles
`en_vigueur` Le support réglementaire est en vigueur.

reference string

Une chaîne de caractères arbitraire rattachée à l'objet. Utile pour rechercher le support réglementaire.

256 max length

Réponses

200 OK

Retourne un Objet Support Réglementaire contenant les données demandées.

PATCH /supports_reglementaires/{support_reglementaire_id}

Schéma de la réponse

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

nature string required

Nature du support réglementaire.

Valeurs possibles
`arrete` Arrêté.
`article` Article.
`arretes_prefectoraux` Ensemble d'arrêtés préfectoraux.
`articles` Ensemble d'articles.
`guides` Guides.
`local_autre_texte` Texte réglementaire local.
`doctrine` Doctrine.
`textes_nationaux_autre_texte` Texte réglementaire national.
`avis_ccs` Avis du Conseil Consultatif de la Sécurité.
`instructions_techniques` Instructions techniques.

legifrance_cid string required nullable

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_vigueur` Le 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