Points de terminaison d'API REST pour Dossiers Rattachements

DeleteRattachementDossiersRattachements

Suppression d'un rattachement d'un dossier

Suppression d'un rattachement d'un dossier.

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 /dossiers_rattachements/{rattachement_id}

PostRattachementDossiersRattachements

Mise à jour d'un rattachement de dossier

Mise à jour d'un rattachement 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

type string

Type de rattachement entre les dossiers.

Valeurs possibles
`SOUS_DOSSIER` Rattachement entre un dossier parent et un dossier enfant.

Réponses

200 OK

Retourne un Dossier Rattachement contenant les données demandées.

POST /dossiers_rattachements/{rattachement_id}

Schéma de la réponse

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

type string required

Type de rattachement entre les dossiers.

Valeurs possibles
`SOUS_DOSSIER` Rattachement entre un dossier parent et un dossier enfant.

dossier_enfant object required

Dossier enfant rattaché au dossier parent.

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

objet string required

Objet du dossier.

256 max length

date_de_creation string required

Date de création du dossier.

format : date-time 20 min length 50 max length

createur object required nullable

Utilisateur ayant créé le dossier.

id string required

Identifiant unique de l'utilisateur.

256 max length

first_name string required nullable

Prénom de l'utilisateur.

256 max length

last_name string required nullable

Nom de l'utilisateur.

256 max length

created_at string required

Date à laquelle l'utilisateur a été créé.

format : date-time 20 min length 50 max length

updated_at string required nullable

Date à laquelle l'utilisateur a été mis à jour.

format : date-time 20 min length 50 max length

timezone string required

Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

256 max length

is_active boolean required

État d'activation du compte utilisateur.

is_verified boolean required

État de vérification du compte utilisateur.

fonction string required nullable

Fonction de l'utilisateur.

256 max length

avatar_url string required nullable

Lien URL vers l'avatar de l'utilisateur.

format : uri 512 max length

roles array of string unique items required nullable

Liste des rôles de l'utilisateur.

10 max items

string

Le rôle de l'utilisateur.

Valeurs possibles
`administrateur_fonctionnel` Administrateur fonctionnel.
`valideur` Valideur.
`visionneur_simple` Visionneur simple.
`visionneur_complet` Visionneur complet.
`attributeur` Attributeur.
`relecteur` Relecteur.
`rapporteur` Rapporteur.
`preventionniste` Préventionniste.
`secretariat_commission_securite` Secrétariat commission de sécurité.
`secretariat` Secrétariat.

application_utilisee_nom string required nullable

Nom de l'application / intégration ayant généré le dossier.

256 max length

statut string required

Indicateur permettant de savoir si le dossier est en cours de traitement.

Valeurs possibles
`OUVERT` Le dossier est en cours de traitement.
`CLOS` Le dossier est clos et ne peut plus être modifié.

modules array of string unique items required

Modules du dossier.

4 max items

string

Modules activables sur un dossier. Un module est une fonctionnalité qui peut être activée ou désactivée sur un dossier.

Valeurs possibles
`erp:analyse_de_risque` Module d'analyse de risque pour les ERP.
`erp:essais_visite` Module de gestion des essais et visites pour les ERP.
`erp:derogations` Module de gestion des dérogations pour les ERP.
`deci:controle_technique_pei` Module de gestion des contrôles techniques pour les PEI.

tags array of object required

Tags du dossier.

25 max items

message string required

Libellé du tag.

Valeurs possibles
`reprise_de_donnees` Tag de reprise de données.
`platau` Tag des dossiers Pla'AU.
`hors_delai` Tag des hors délai.

est_archive boolean required

Indicateur permettant de savoir si le dossier est archivé. Un dossier archivé ne peut plus être modifié. Cela peut être utile pour des raisons de traçabilité.

passages_en_commission array of object required nullable

Information permettant de savoir si le dossier est actuellement programmé à l'ordre du jour d'une ou plusieurs commissions.

5 max items

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

date_debut string required

Date de début du passage en commission programmée.

format : date-time 20 min length 50 max length

date_fin string required

Date de fin du passage en commission programmée.

format : date-time 20 min length 50 max length

type string required

Type du passage en commission.

Valeurs possibles
`salle` Passage en commission en salle.
`visite_reception_travaux_en_groupe_de_visite` Visite de réception de travaux en groupe de visite.
`visite_reception_avant_ouverture_en_groupe_de_visite` Visite de réception avant ouverture en groupe de visite.
`visite_periodique_en_groupe_de_visite` Visite périodique en groupe de visite.
`visite_inopinee_en_groupe_de_visite` Visite inopinée en groupe de visite.
`visite_controle_en_groupe_de_visite` Visite de contrôle en groupe de visite.
`visite_chantier_en_groupe_de_visite` Visite de chantier en groupe de visite.
`visite_conseil_en_groupe_de_visite` Visite de conseil en groupe de visite.
`visite_reception_travaux_en_pleniere` Visite de réception de travaux en plénière.
`visite_reception_avant_ouverture_en_pleniere` Visite de réception avant ouverture en plénière.
`visite_periodique_en_pleniere` Visite périodique en plénière.
`visite_inopinee_en_pleniere` Visite inopinée en plénière.
`visite_controle_en_pleniere` Visite de contrôle en plénière.
`visite_chantier_en_pleniere` Visite de chantier en plénière.
`visite_conseil_en_pleniere` Visite de conseil en plénière.

libelle string required

Libellé de la date de passage en commission. Souvent utile pour affichage aux utilisateurs.

256 max length

raison_reprogrammation string required nullable

Si la date de passage en commission a été reprogrammé, alors cette propriété contient la raison de la reprogrammation.

256 max length

nb_dossiers integer required

Nombre de dossiers à l'ordre du jour.

format : int32 ≥=0 ≤=150

commission object required

Commission en charge du passage en commission.

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

type string required

Type de la commission (peut être une commission de sécurité, un conseil départemental ...).

Valeurs possibles
`Sous-commission départementale` Commission de sécurité des établissements recevant du public (ERP) et des immeubles de grande hauteur (IGH) compétente sur le département.
`Commission communale` Commission de sécurité des établissements recevant du public (ERP) et des immeubles de grande hauteur (IGH) compétente sur une commune.
`Commission intercommunale` Commission de sécurité des établissements recevant du public (ERP) et des immeubles de grande hauteur (IGH) compétente sur une intercommunalité.
`Commission d'arrondissement` Commission de sécurité des établissements recevant du public (ERP) et des immeubles de grande hauteur (IGH) compétente sur un arrondissement.
`CoDERST` Conseil départemental de l'environnement et des risques sanitaires et technologiques.

libelle string required

Nom de la commission.

256 max length

presidence object required

Organisation présidant la commission.

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

nom string required

Nom de l'organisation.

256 max length

logo_url string required nullable

Lien URL vers le logo représentant l'organisation.

format : uri 512 max length

type string required

Type de l'organisation.

Valeurs possibles
`sis` Organisation de type Service d'Incendie et de Secours.

secretariat object required

Organisation tenant le secrétariat de la commission.

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

nom string required

Nom de l'organisation.

256 max length

logo_url string required nullable

Lien URL vers le logo représentant l'organisation.

format : uri 512 max length

type string required

Type de l'organisation.

Valeurs possibles
`sis` Organisation de type Service d'Incendie et de Secours.

couleur string nullable

Couleur associée à la commission, utilisée notamment pour l'affichage dans les calendriers. La couleur doit être au format hexadécimal sans le symbole '#' (Ex: RRGGBB).

pattern ^[0-9A-Fa-f]{6}$ 6 fixed length

organisation_id string required

Identifiant de l’organisation de la commission.

format : uuid 36 fixed length

organisation_id string required

Identifiant de l’organisation de la commission.

format : uuid 36 fixed length

avis string nullable

Avis rendu de la commission sur le dossier.

Valeurs possibles
`favorable` Avis favorable.
`defavorable` Avis défavorable.

enveloppe object required nullable

Enveloppe du dossier.

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

workflows_actifs array of string unique items required

Workflows actifs du dossier. Un workflow actif est un workflow qui est en cours de traitement.

12 max items

string

Type du workflow.

Valeurs possibles
`analyse_de_risque` Analyse de risque.
`validation` Validation.
`arrivee_sis` Arrivée SIS.
`arrivee_sis_prev` Arrivée SIS préventive.
`arrivee_secretariat_commission` Arrivée au secrétariat de la commission.
`consultation_sis` Consultation SIS.
`passage_commission` Passage en commission.
`relecture` Relecture.
`visite` Visite.
`arrivee_secretariat` Arrivée au secrétariat.
`workflow` Workflow générique.
`reception_de_travaux_en_attente` Réception de travaux en attente.

nb_messages_fil_rouge integer required

Nombre de messages dans le fil rouge du dossier.

format : int32 ≥=0 ≤=999999

nb_contacts integer required

Nombre de contacts associés au dossier.

format : int32 ≥=0 ≤=999999

nb_pieces_jointes integer required

Nombre de pièces jointes associées au dossier.

format : int32 ≥=0 ≤=999999

affectations array of object required

Représente le groupe de travail du dossier.

25 max items

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

role string required

Role sur le traitement du dossier.

Valeurs possibles
`admin` Administrateur du dossier.
`preventionniste` Préventionniste.
`secretariat_prev` Secrétariat prévention.
`rapporteur` Rapporteur.
`relecteur\|valideur` Relecteur ou valideur.

utilisateur object required

Utilisateur affecté au dossier.

id string required

Identifiant unique de l'utilisateur.

256 max length

first_name string required nullable

Prénom de l'utilisateur.

256 max length

last_name string required nullable

Nom de l'utilisateur.

256 max length

created_at string required

Date à laquelle l'utilisateur a été créé.

format : date-time 20 min length 50 max length

updated_at string required nullable

Date à laquelle l'utilisateur a été mis à jour.

format : date-time 20 min length 50 max length

timezone string required

Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

256 max length

is_active boolean required

État d'activation du compte utilisateur.

is_verified boolean required

État de vérification du compte utilisateur.

fonction string required nullable

Fonction de l'utilisateur.

256 max length

avatar_url string required nullable

Lien URL vers l'avatar de l'utilisateur.

format : uri 512 max length

roles array of string unique items required nullable

Liste des rôles de l'utilisateur.

10 max items

string

Le rôle de l'utilisateur.

Valeurs possibles
`administrateur_fonctionnel` Administrateur fonctionnel.
`valideur` Valideur.
`visionneur_simple` Visionneur simple.
`visionneur_complet` Visionneur complet.
`attributeur` Attributeur.
`relecteur` Relecteur.
`rapporteur` Rapporteur.
`preventionniste` Préventionniste.
`secretariat_commission_securite` Secrétariat commission de sécurité.
`secretariat` Secrétariat.

organisation_id string required

Identifiant de l’organisation à laquelle appartient le dossier.

format : uuid 36 fixed length

dossiers_enfants array required

Dossier rattaché au dossier. Le rattachement permet de définir une relation entre deux dossiers.

100 max items

object