> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/api-reference/efalia-doc-api/gabaritdedossier.md). # GabaritDeDossier ## GET /api/gabarits-de-dossier/{id} > Récupération d'un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"x-api-key","in":"header","description":"Clé d'API définie dans le manifeste de Doc dans la partie `Efalia Process > Clé API`."}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{id}":{"get":{"operationId":"gabaritDossier","summary":"Récupération d'un gabarit de dossier","tags":["GabaritDeDossier"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"responses":{"200":{"description":"Un tableau JSON du gabarit de dossier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Renommer un gabarit de dossier > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\ > Utilisez l'endpoint \`/api/journal-taches\` pour suivre l'avancement. ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{id}":{"put":{"operationId":"renommerGabaritDossier","summary":"Renommer un gabarit de dossier","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\nUtilisez l'endpoint `/api/journal-taches` pour suivre l'avancement.","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nom","description"],"properties":{"nom":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"200":{"description":"Le gabarit a été renommé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"Les données sont invalides","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["libelle_obligatoire","libelle_trop_long","description_trop_longue","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## DELETE /api/gabarits-de-dossier/{id} > Supprimer un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{id}":{"delete":{"operationId":"supprimerGabaritDossier","summary":"Supprimer un gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"responses":{"204":{"description":"Le gabarit a été supprimé"},"400":{"description":"Le gabarit n'est pas vide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_contient_des_elements","gabarit_de_dossier_utilise_dans_un_lien","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## PUT /api/gabarits-de-dossier/{id}/id-externe > Modifier l'id externe d'un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{id}/id-externe":{"put":{"operationId":"modifierIdExterneGabaritDossier","summary":"Modifier l'id externe d'un gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idExterne"],"properties":{"idExterne":{"$ref":"#/components/schemas/idExterne"}}}}}},"responses":{"200":{"description":"Le gabarit a été modifié","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"L'id externe est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["format_payload_invalide","id_externe_trop_long"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Modifier le modèle de nom dynamique d'un gabarit de dossier > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\ > Utilisez l'endpoint \`/api/journal-taches\` pour suivre l'avancement. ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{id}/modele-nom-dynamique":{"put":{"operationId":"modifierModeleNomDynamiqueGabaritDossier","summary":"Modifier le modèle de nom dynamique d'un gabarit de dossier","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\nUtilisez l'endpoint `/api/journal-taches` pour suivre l'avancement.","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["modeleNomDynamique"],"properties":{"modeleNomDynamique":{"type":"string"}}}}}},"responses":{"200":{"description":"Le modèle a été modifié","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"Le modèle n'est pas valide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["modele_nom_dynamique_requis","modele_nom_dynamique_trop_long","au_moins_un_parametre_substitutif_requis_dans_modele_nom_dynamique","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit dossier","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Ajout d'une nouvelle métadonnée au gabarit de dossier > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\ > Utilisez l'endpoint \`/api/journal-taches\` pour suivre l'avancement. ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"idExterne":{"type":"string","maxLength":255},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{id}/metadonnees":{"post":{"operationId":"ajouterMetadonneeGabaritDossier","summary":"Ajout d'une nouvelle métadonnée au gabarit de dossier","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\nUtilisez l'endpoint `/api/journal-taches` pour suivre l'avancement.","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Requete ajout metadonnee","type":"object","required":["format","libelle","aide","obligatoire"],"properties":{"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean","description":"S'il s'agit de la première métadonnée elle doit être obligatoire"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["valeur"],"properties":{"valeur":{"type":"string","description":"Une des valeurs possibles de la liste","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est nécessaire que pour le format `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé ne s'applique que pour le format `enum`"}}}}}},"responses":{"201":{"description":"La métadonnée a été ajoutée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["libelle_obligatoire","libelle_trop_long","description_trop_longue","au_moins_un_parametre_substitutif_requis_dans_modele_nom_dynamique","des_dossiers_existent_deja","format_payload_invalide","liste_predefinie_vide","format_enum_sans_liste_predefinie","id_externe_trop_long"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Modification d'une métadonnée d'un gabarit de dossier > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\ > Utilisez l'endpoint \`/api/journal-taches\` pour suivre l'avancement. ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"idExterne":{"type":"string","maxLength":255},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/metadonnees/{id}":{"put":{"operationId":"modifierMetadonneeGabaritDossier","summary":"Modification d'une métadonnée d'un gabarit de dossier","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\nUtilisez l'endpoint `/api/journal-taches` pour suivre l'avancement.","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}},{"in":"path","name":"id","description":"L'id de la métadonnée","required":true,"schema":{"$ref":"#/components/schemas/StructureMetadonneeId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","libelle","aide","obligatoire"],"properties":{"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"valeurs":{"type":"array","items":{"type":"object","required":["valeur"],"properties":{"valeur":{"type":"string","description":"Une des valeurs possibles de la liste","maxLength":255},"id":{"type":"string","format":"uuid"},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est nécessaire que pour le format `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé ne s'applique que pour le format `enum`"}}}}}},"responses":{"200":{"description":"La métadonnée a été modifiée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["libelle_obligatoire","libelle_trop_long","description_trop_longue","des_dossiers_existent_deja","au_moins_un_parametre_substitutif_requis_dans_modele_nom_dynamique","format_payload_invalide","liste_predefinie_vide","format_enum_sans_liste_predefinie","metadonnee_utilisee_dans_un_lien","metadonnee_avec_valeurs_non_renseignees_ne_peut_etre_obligatoire"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier ou la métadonnée n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Suppression d'une métadonnée d'un gabarit de dossier > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\ > Utilisez l'endpoint \`/api/journal-taches\` pour suivre l'avancement. ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/metadonnees/{id}":{"delete":{"operationId":"supprimerMetadonneeGabaritDossier","summary":"Suppression d'une métadonnée d'un gabarit de dossier","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente des dossiers et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\nUtilisez l'endpoint `/api/journal-taches` pour suivre l'avancement.","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}},{"in":"path","name":"id","description":"L'id de la métadonnée à supprimer","required":true,"schema":{"$ref":"#/components/schemas/StructureMetadonneeId"}}],"responses":{"200":{"description":"La métadonnée a été supprimée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"La métadonnée est utilisée dans le modèle de nom dynamique ou un gabarit de document","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["metadonnee_utilisee_dans_une_duc","metadonnee_utilisee_dans_une_dua","metadonnee_utilisee_dans_nom_dynamique","metadonnee_utilisee_dans_un_lien","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier ou la métadonnée n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant","metadonnee_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## PUT /api/gabarits-de-dossier/{gabarit}/metadonnees/{id}/id-externe > Modification de l'id externe d'une métadonnée d'un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/metadonnees/{id}/id-externe":{"put":{"operationId":"modifierIdExterneMetadonneeGabaritDossier","summary":"Modification de l'id externe d'une métadonnée d'un gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}},{"in":"path","name":"id","description":"L'id de la métadonnée","required":true,"schema":{"$ref":"#/components/schemas/StructureMetadonneeId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idExterne"],"properties":{"idExterne":{"$ref":"#/components/schemas/idExterne"}}}}}},"responses":{"200":{"description":"La métadonnée a été modifiée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"L'id externe est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["format_payload_invalide","id_externe_trop_long"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier ou la métadonnée n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## DELETE /api/gabarits-de-dossier/{gabarit}/metadonnees/{metadonnee}/valeurs/{id} > Suppression d'une valeur inactive et inutilisée d'une metadonnée d'un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"FiltreAccesId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/metadonnees/{metadonnee}/valeurs/{id}":{"delete":{"operationId":"supprimerValeurInactiveEnumMetadonneGabaritDossier","summary":"Suppression d'une valeur inactive et inutilisée d'une metadonnée d'un gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}},{"in":"path","name":"metadonnee","description":"L'id de la métadonnée à supprimer","required":true,"schema":{"$ref":"#/components/schemas/StructureMetadonneeId"}},{"in":"path","name":"id","description":"L'id de la valeur inactive à supprimer","required":true,"schema":{"$ref":"#/components/schemas/ValeurMetadonneeId"}}],"responses":{"200":{"description":"La valeur de l'enum a été supprimée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"La valeur de l'enum de cette métadonnée est utilisé","content":{"application/json":{"schema":{"title":"Requête invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["valeur_enum_metadonnee_active","valeur_enum_metadonnee_utilisee","valeur_enum_metadonnee_requise","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier, la métadonnée ou la valeur d'enum de la métadonnée n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant","metadonnee_inexistante","valeur_enum_metadonnee_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## POST /api/gabarits-de-dossier/{id}/liens-vers-gabarit-de-dossier > Création d'un lien vers un autre gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"LienVersGabaritDeDossier":{"type":"object","required":["id","gabarit","metadonnee"],"properties":{"id":{"$ref":"#/components/schemas/LienVersGabaritDeDossierId"},"gabarit":{"type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"}}},"metadonnee":{"type":"object","required":["source","cible"],"properties":{"source":{"$ref":"#/components/schemas/StructureMetadonneeId"},"cible":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},"LienVersGabaritDeDossierId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{id}/liens-vers-gabarit-de-dossier":{"post":{"operationId":"creerLienGabaritDossier","summary":"Création d'un lien vers un autre gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["gabarit","metadonnee"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnee":{"type":"object","required":["source","cible"],"properties":{"source":{"$ref":"#/components/schemas/StructureMetadonneeId"},"cible":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}}}}},"responses":{"201":{"description":"Le lien a été créé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LienVersGabaritDeDossier"}}}},"400":{"description":"Les formats des métadonnées ne sont pas identiques","content":{"application/json":{"schema":{"title":"Ressource invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["formats_des_metadonnees_du_lien_doivent_etre_identiques"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier ou une des métadonnées n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## PUT /api/liens-vers-gabarit-de-dossier/{id} > Modifier un lien vers un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"LienVersGabaritDeDossierId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"LienVersGabaritDeDossier":{"type":"object","required":["id","gabarit","metadonnee"],"properties":{"id":{"$ref":"#/components/schemas/LienVersGabaritDeDossierId"},"gabarit":{"type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"}}},"metadonnee":{"type":"object","required":["source","cible"],"properties":{"source":{"$ref":"#/components/schemas/StructureMetadonneeId"},"cible":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/liens-vers-gabarit-de-dossier/{id}":{"put":{"operationId":"modifierLienGabaritDossier","summary":"Modifier un lien vers un gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du lien","required":true,"schema":{"$ref":"#/components/schemas/LienVersGabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Le gabarit est le gabarit de dossier cible","type":"object","required":["gabarit","metadonnee"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnee":{"type":"object","required":["source","cible"],"properties":{"source":{"$ref":"#/components/schemas/StructureMetadonneeId"},"cible":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}}}}},"responses":{"200":{"description":"Le lien a été modifié","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LienVersGabaritDeDossier"}}}},"400":{"description":"Les formats des métadonnées ne sont pas identiques","content":{"application/json":{"schema":{"title":"Ressource invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["formats_des_metadonnees_du_lien_doivent_etre_identiques"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Une ressource n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["lien_inexistant","gabarit_de_dossier_inexistant","metadonnee_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## DELETE /api/liens-vers-gabarit-de-dossier/{id} > Supprimer un lien vers un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"LienVersGabaritDeDossierId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/liens-vers-gabarit-de-dossier/{id}":{"delete":{"operationId":"supprimerLienGabaritDossier","summary":"Supprimer un lien vers un gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du lien","required":true,"schema":{"$ref":"#/components/schemas/LienVersGabaritDeDossierId"}}],"responses":{"204":{"description":"Le lien est supprimé"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le lien n'existe pas","content":{"application/json":{"schema":{"title":"Lien inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["lien_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## POST /api/gabarits-de-dossier/{gabarit}/filtres-acces > Associer un filtre d'accès à un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/filtres-acces":{"post":{"operationId":"associerFiltreAccesGabaritDeDossier","summary":"Associer un filtre d'accès à un gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filtre"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"}}}}}},"responses":{"200":{"description":"Le filtre a été associé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier ou le filtre n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant","filtre_acces_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## DELETE /api/gabarits-de-dossier/{gabarit}/filtres-acces/{id} > Dissocier un filtre d'accès d'un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/filtres-acces/{id}":{"delete":{"operationId":"dissocierFiltreAccesGabaritDeDossier","summary":"Dissocier un filtre d'accès d'un gabarit de dossier","tags":["GabaritDeDossier","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}},{"in":"path","name":"id","description":"L'id du filtre d'accès à supprimer","required":true,"schema":{"$ref":"#/components/schemas/FiltreAccesId"}}],"responses":{"200":{"description":"Le filtre d'accès a été dissoccié","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDossier"}}}},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_contient_des_elements","filtre_acces_utilise_dans_habilitation"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier ou le filtre d'accès n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant","filtre_acces_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Lister les gabarits de document d'un gabarit de dossier > Les gabarits de document des catégories ne sont pas retournés.\ > \ > ⚠️ Cet endpoint est déprécié et sera supprimé dans une future révision : veuillez passer par \`GET /api/plan-de-classement\`. ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"GabaritDeDocument"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"GabaritDeDocument":{"type":"object","required":["id","nom","description","idExterne","modeleNomDynamique","metadonnees","indexationDemandeeLe","rechercheDansContenu","versionnementActive"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"nom":{"type":"string"},"description":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"gabaritDeDossier":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"rechercheDansContenu":{"type":"boolean"},"groupement":{"type":"object","required":["metadonnee"],"properties":{"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"},"periode":{"type":"string","enum":["annee-mois","annee"]}}},"dureeUtiliteCourante":{"oneOf":[{"type":"object","required":["gabaritDeDossier"],"properties":{"gabaritDeDossier":{"type":"object","required":["duree","unite","metadonnee"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},{"type":"object","required":["gabaritDeDocument"],"properties":{"gabaritDeDocument":{"type":"object","required":["duree","unite","metadonnee"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},{"type":"object","required":["dateDeCreationDocument"],"properties":{"dateDeCreationDocument":{"type":"object","required":["duree","unite"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]}}}}}]},"dureeUtiliteAdministrative":{"type":"object","required":["duree","unite","metadonnee","sortFinal"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"type":"string"},"sortFinal":{"type":"string","enum":["destruction","archivage"]}}},"versionnementActive":{"type":"boolean"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"ConteneurId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/gabarits-de-document":{"get":{"operationId":"listerGabaritsDocumentGabaritDossier","summary":"Lister les gabarits de document d'un gabarit de dossier","description":"Les gabarits de document des catégories ne sont pas retournés.\n\n⚠️ Cet endpoint est déprécié et sera supprimé dans une future révision : veuillez passer par `GET /api/plan-de-classement`.","deprecated":true,"tags":["GabaritDeDossier","GabaritDeDocument"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"responses":{"200":{"description":"Un tableau JSON des gabarits de document","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GabaritDeDocument"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## POST /api/gabarits-de-dossier/{gabarit}/gabarits-de-document > Créer un gabarit de document dans un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"GabaritDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"InputGabaritDeDocument":{"type":"object","required":["nom","description","metadonnees"],"properties":{"nom":{"type":"string"},"description":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"metadonnees":{"type":"array","items":{"type":"object","required":["format","libelle","aide","obligatoire"],"properties":{"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["valeur"],"properties":{"valeur":{"type":"string","description":"Une des valeurs possibles de la liste"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé ne s'applique que pour le format `enum`, elle est obligatoire dans ce cas-là"},"choixMultiple":{"type":"boolean","description":"Cette clé ne s'applique que pour le format `enum`, elle est obligatoire dans ce cas-là"}}}},"rechercheDansContenu":{"type":"boolean","description":"Cette propriété n'est utile que lorsqu'on veut activer la recherche dans le contenu (par défaut c'est désactivé)"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}},"idExterne":{"type":"string","maxLength":255},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ConteneurId":{"type":"string","format":"uuid"},"GabaritDeDocument":{"type":"object","required":["id","nom","description","idExterne","modeleNomDynamique","metadonnees","indexationDemandeeLe","rechercheDansContenu","versionnementActive"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"nom":{"type":"string"},"description":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"gabaritDeDossier":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"rechercheDansContenu":{"type":"boolean"},"groupement":{"type":"object","required":["metadonnee"],"properties":{"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"},"periode":{"type":"string","enum":["annee-mois","annee"]}}},"dureeUtiliteCourante":{"oneOf":[{"type":"object","required":["gabaritDeDossier"],"properties":{"gabaritDeDossier":{"type":"object","required":["duree","unite","metadonnee"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},{"type":"object","required":["gabaritDeDocument"],"properties":{"gabaritDeDocument":{"type":"object","required":["duree","unite","metadonnee"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},{"type":"object","required":["dateDeCreationDocument"],"properties":{"dateDeCreationDocument":{"type":"object","required":["duree","unite"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]}}}}}]},"dureeUtiliteAdministrative":{"type":"object","required":["duree","unite","metadonnee","sortFinal"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"type":"string"},"sortFinal":{"type":"string","enum":["destruction","archivage"]}}},"versionnementActive":{"type":"boolean"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonneeId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/gabarits-de-document":{"post":{"operationId":"creerGabaritDocumentGabaritDossier","summary":"Créer un gabarit de document dans un gabarit de dossier","tags":["GabaritDeDossier","GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputGabaritDeDocument"}}}},"responses":{"201":{"description":"Le nouveau gabarit de document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDocument"}}}},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["libelle_obligatoire","libelle_trop_long","description_trop_longue","au_moins_un_parametre_substitutif_requis_dans_modele_nom_dynamique","liste_predefinie_vide","format_payload_invalide","format_enum_sans_liste_predefinie","id_externe_trop_long"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## POST /api/gabarits-de-dossier/{gabarit}/categories-de-gabarits-de-document > Créer une catégorie de gabarits de document dans un gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"CategoriesDeGabaritsDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"CategorieDeGabaritsDeDocument":{"type":"object","required":["id","nom","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"CategorieDeGabaritsDeDocumentId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/categories-de-gabarits-de-document":{"post":{"operationId":"creerCategorieGabaritDocument","summary":"Créer une catégorie de gabarits de document dans un gabarit de dossier","tags":["GabaritDeDossier","CategoriesDeGabaritsDeDocument","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}}}}},"responses":{"201":{"description":"La nouvelle catégorie de gabarits de document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocument"}}}},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["libelle_obligatoire","libelle_trop_long","format_payload_invalide","id_externe_trop_long"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## GET /api/gabarits-de-dossier/{gabarit}/dossiers > Lister les dossiers existants pour ce gabarit de dossier ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Dossier"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"x-api-key","in":"header","description":"Clé d'API définie dans le manifeste de Doc dans la partie `Efalia Process > Clé API`."}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"DossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"UtilisateurId":{"type":"string","format":"uuid"}},"parameters":{"Range":{"in":"header","name":"Range","description":"Header pour spécifier la tranche d'objets à sélectionner.\n\nSi aucune pagination n'est demandée la réponse contiendra au maximum `1000` objets, veuillez donc vérifier le code retour de la réponse pour vérifier si vous devez faire d'autres appels pour récupérer les autres objets.\n\nLa tranche maximum est de `1000` objets, si vous demandez plus alors la réponse contiendra au maximum `1000` objets. Il faut donc bien prendre en compte le header `Content-Range` contenu dans la réponse.","schema":{"type":"string","description":"Si vous voulez paginer par tranches de 10, il faudra utiliser les tranches `0-9`, `10-19`, `20-29`, etc...","pattern":"^resources (\\d+)-(\\d+)$"}}},"headers":{"ContentRange":{"schema":{"type":"string","description":"`Content-Range: 0-99/500` indique que la réponse contient les `100` premiers objets. Le header de réponse `Content-Range: 500-504/505` indique qu'on est arrivé à la fin"}}},"responses":{"PaginationRangeErronee":{"description":"Les bornes pour la pagination demandée sont erronées","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["erreur_borne_pagination"]},"message":{"type":"string"}}}}}},"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"PaginationImpossible":{"description":"La pagination demandée dépasse les données disponibles","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/dossiers":{"get":{"operationId":"listerDossiers","summary":"Lister les dossiers existants pour ce gabarit de dossier","tags":["GabaritDeDossier","Dossier"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"description":"Un tableau JSON des dossiers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dossier"}}}}},"206":{"description":"Un tableau JSON des dossiers pour la tranche demandée","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dossier"}}}},"headers":{"Content-Range":{"$ref":"#/components/headers/ContentRange"}}},"400":{"$ref":"#/components/responses/PaginationRangeErronee"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"416":{"$ref":"#/components/responses/PaginationImpossible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Créer un nouveau dossier > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente du dossier et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\ > Utilisez l'endpoint \`/api/journal-taches\` pour suivre l'avancement. ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDossier"},{"name":"Dossier"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"x-api-key","in":"header","description":"Clé d'API définie dans le manifeste de Doc dans la partie `Efalia Process > Clé API`."}},"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"},"InputMetadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"string","description":"L'id associé à la valeur prédéfinie choisie","format":"uuid"},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"UtilisateurId":{"type":"string","format":"uuid"},"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"DossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/gabarits-de-dossier/{gabarit}/dossiers":{"post":{"operationId":"creerDossier","summary":"Créer un nouveau dossier","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente du dossier et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\nUtilisez l'endpoint `/api/journal-taches` pour suivre l'avancement.","tags":["GabaritDeDossier","Dossier"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de dossier","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["metadonnees"],"properties":{"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/InputMetadonnee"}},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}}}}}}},"responses":{"201":{"description":"Le dossier a été créé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dossier"}}}},"204":{"description":"Le dossier a été créé mais non habilité à le consulter"},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["metadonnee_non_renseignee","format_valeur_metadonnee_invalide","modele_nom_dynamique_requis","filtre_acces_non_defini_sur_gabarit_de_dossier","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier, une valeur de filtre d'accès ou un utilisateur n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_inexistant","filtre_acces_valeur_inexistante","utilisateur_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://documentation.efalia.com/api-reference/efalia-doc-api/gabaritdedossier.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.