> 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/gabaritdedocument.md). # GabaritDeDocument ## GET /api/gabarits-de-document/{id} > Recupération d'un gabarit de document ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDocument"}],"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":{"GabaritDeDocumentId":{"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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-document/{id}":{"get":{"operationId":"gabaritDocument","summary":"Recupération d'un gabarit de document","tags":["GabaritDeDocument"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"responses":{"200":{"description":"Le gabarit au format JSON","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDocument"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document 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_document_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Modifier un gabarit de document > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente 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":"GabaritDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"}},"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-document/{id}":{"put":{"operationId":"modifierGabaritDocument","summary":"Modifier un gabarit de document","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente 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":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nom","description"],"properties":{"nom":{"type":"string"},"description":{"type":"string"},"rechercheDansContenu":{"type":"boolean","description":"Ne pas spécifier cette clé ne modifiera pas la valeur de ce flag.\n\nIl est préférable d'utiliser l'endpoint dédié à la modification de ce flag","deprecated":true},"groupement":{"description":"L'absence de cette section désactive le groupement. Il est possible de grouper sur les formats `date`, `bool` et `enum`","type":"object","required":["metadonnee"],"properties":{"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"},"periode":{"type":"string","enum":["annee-mois","annee"],"description":"Cette période est nécessaire lorsque le groupement est fait sur une métadonnée au format `date`."}}},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}}}}},"responses":{"200":{"description":"Le gabarit a été renommé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDocument"}}}},"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","periode_groupement_requise","groupement_impossible","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document ou la métadonnée de groupement 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_document_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## DELETE /api/gabarits-de-document/{id} > Supprimer un gabarit de document ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"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":{"GabaritDeDocumentId":{"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-document/{id}":{"delete":{"operationId":"supprimerGabaritDocument","summary":"Supprimer un gabarit de document","tags":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"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_document_contient_des_elements","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document 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_document_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## PUT /api/gabarits-de-document/{id}/id-externe > Modifier l'id-externe d'un gabarit de document ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"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":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"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"}}},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"]}}}}}},"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-document/{id}/id-externe":{"put":{"operationId":"modifierIdExterneGabaritDocument","summary":"Modifier l'id-externe d'un gabarit de document","tags":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"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/GabaritDeDocument"}}}},"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 document 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_document_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## PUT /api/gabarits-de-document/{id}/recherche-dans-contenu > Activer/désactiver la recherche dans le contenu des documents du gabarit de document ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"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":{"GabaritDeDocumentId":{"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"]}}}}}},"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-document/{id}/recherche-dans-contenu":{"put":{"operationId":"activerRechercheDansContenuPourUnGabaritDeDocument","summary":"Activer/désactiver la recherche dans le contenu des documents du gabarit de document","tags":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Le gabarit a été modifié","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDocument"}}}},"400":{"description":"Requete invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document 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_document_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## PUT /api/gabarits-de-document/{id}/versionnement > Activer/désactiver le versionnement des binaires d'un document ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"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":{"GabaritDeDocumentId":{"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"]}}}}}},"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-document/{id}/versionnement":{"put":{"operationId":"activerVersionnementGabaritDocument","summary":"Activer/désactiver le versionnement des binaires d'un document","tags":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean"}}}}}},"responses":{"200":{"description":"L'option a été modifiée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDocument"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document 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_document_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Modifier le modèle de nom dynamique d'un gabarit de document > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente 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":"GabaritDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDocumentId":{"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"]}}}}}},"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-document/{id}/modele-nom-dynamique":{"put":{"operationId":"modifierModeleNomDynamiqueGabaritDocument","summary":"Modifier le modèle de nom dynamique d'un gabarit de document","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente 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":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"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/GabaritDeDocument"}}}},"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 document 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_document_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Créer un document directement classé > La clé \`dossier\` est nécessaire uniquement lorsque le document est à classer dans un dossier.\ > \ > Le contenu de la requête est un multipart/form-data, le contenu est donc au même format qu'un formulaire c'est à dire une liste à plat de clé valeur (ie \`array\\`).\ > \ > Pour cet endpoint uniquement, il ne faut pas envoyer la métadonnée si sa valeur est \`null\` ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDocument"},{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[]},{"ApiKey":[],"Impersonification":[]}],"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":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"DossierId":{"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"},"Document":{"type":"object","required":["id","nom","mediaType","classe","preClasse","creeLe","misAJourLe","metadonnees","indexationDemandeeLe","indexeLe","empreinte","verrouille","versions","creePar"],"properties":{"id":{"$ref":"#/components/schemas/DocumentId"},"nom":{"type":"string"},"mediaType":{"type":"string","description":"Media type de la version la plus récente"},"classe":{"type":"boolean"},"preClasse":{"type":"boolean"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"dossier":{"$ref":"#/components/schemas/DossierId"},"bannette":{"$ref":"#/components/schemas/BannetteId"},"creeLe":{"type":"string","format":"date-time"},"misAJourLe":{"type":"string","format":"date-time"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"empreinte":{"type":"string","description":"Empreinte de la version la plus récente"},"verrouille":{"type":"boolean"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/Version"}},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"objetNumeriqueCCFN":{"type":"object","required":["objetNumerique","conteneur","empreinte","algorithmeEmpreinte","creeLe"],"properties":{"objetNumerique":{"type":"string","format":"uuid"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"},"empreinte":{"type":"string"},"algorithmeEmpreinte":{"type":"string"},"creeLe":{"type":"string","format":"date-time"}}},"suppressionPrevueLe":{"type":"string","format":"date-time"}}},"DocumentId":{"type":"string","format":"uuid"},"BannetteId":{"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"},"Version":{"type":"object","required":["id","mediaType","empreinte","creeLe","nom"],"properties":{"id":{"$ref":"#/components/schemas/VersionId"},"mediaType":{"type":"string"},"empreinte":{"type":"string"},"creeLe":{"type":"string","format":"date-time"},"nom":{"type":"string"}}},"VersionId":{"type":"integer"},"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"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ErreurServeur":{"description":"Le fichier n'a pas pu être écrit correctement","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["fichier_corrompu","ecriture_sur_disque_impossible"]}}}}}}}},"paths":{"/api/gabarits-de-document/{id}/classement-direct":{"post":{"operationId":"classerDirectement","summary":"Créer un document directement classé","description":"La clé `dossier` est nécessaire uniquement lorsque le document est à classer dans un dossier.\n\nLe contenu de la requête est un multipart/form-data, le contenu est donc au même format qu'un formulaire c'est à dire une liste à plat de clé valeur (ie `array`).\n\nPour cet endpoint uniquement, il ne faut pas envoyer la métadonnée si sa valeur est `null`","tags":["GabaritDeDocument","Document"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["fichier","nom"],"properties":{"fichier":{"type":"string","description":"Le fichier à classer","format":"binary"},"nom":{"type":"string"},"dossier":{"$ref":"#/components/schemas/DossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/InputMetadonnee"}}}}}}},"responses":{"201":{"description":"Le document a été classé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été classé mais non habilité à consulter le document"},"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":["nom_origine_obligatoire","nom_origine_encodage_invalide","nom_origine_caracteres_controle_non_autorises","nom_origine_unicode_non_normalise","metadonnee_non_renseignee","format_valeur_metadonnee_invalide","classement_requiert_dossier","modele_nom_dynamique_requis","classement_mauvais_dossier","format_payload_invalide","erreur_upload"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document 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_document_inexistant","dossier_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"500":{"$ref":"#/components/responses/ErreurServeur"},"503":{"description":"Le fichier n'a pas été uploadé correctement ou 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","erreur_depot_efalia_safe"]}}}}}}}}}}} ``` ## Ajout d'une nouvelle métadonnée au gabarit de document > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente 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":"GabaritDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"idExterne":{"type":"string","maxLength":255},"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"}}},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"},"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"]}}}}}},"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-document/{id}/metadonnees":{"post":{"operationId":"ajouterMetadonneeGabaritDocument","summary":"Ajout d'une nouvelle métadonnée au gabarit de document","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente 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":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"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","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/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","des_documents_existent_deja","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 document 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_document_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Modification d'une métadonnée d'un gabarit de document > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente 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":"GabaritDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"idExterne":{"type":"string","maxLength":255},"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"}}},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"},"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"]}}}}}},"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-document/{gabarit}/metadonnees/{id}":{"put":{"operationId":"modifierMetadonneeGabaritDocument","summary":"Modification d'une métadonnée d'un gabarit de document","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente 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":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}},{"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","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/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","des_documents_existent_deja","liste_predefinie_vide","format_payload_invalide","format_enum_sans_liste_predefinie","metadonnee_utilisee_pour_groupement","metadonnee_avec_valeurs_non_renseignees_ne_peut_etre_obligatoire"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document ou la métadonnée n'existe pas","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_document_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Suppression d'une métadonnée d'un gabarit de document > ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente 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":"GabaritDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"},"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-document/{gabarit}/metadonnees/{id}":{"delete":{"operationId":"supprimerMetadonneeGabaritDocument","summary":"Suppression d'une métadonnée d'un gabarit de document","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente 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":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}},{"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/GabaritDeDocument"}}}},"400":{"description":"La métadonnée est utilisée dans le modèle de nom dynamique","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["metadonnee_utilisee_dans_nom_dynamique","metadonnee_utilisee_pour_groupement","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document 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_document_inexistant","metadonnee_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## PUT /api/gabarits-de-document/{gabarit}/metadonnees/{id}/id-externe > Modification de l'id externe d'une métadonnée d'un gabarit de document ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"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":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"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"}}},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"},"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"]}}}}}},"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-document/{gabarit}/metadonnees/{id}/id-externe":{"put":{"operationId":"modifierIdExterneMetadonneeGabaritDocument","summary":"Modification de l'id externe d'une métadonnée d'un gabarit de document","tags":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}},{"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/GabaritDeDocument"}}}},"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 document ou la métadonnée n'existe pas","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_document_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## DELETE /api/gabarits-de-document/{gabarit}/metadonnees/{metadonnee}/valeurs/{id} > Suppression d'une valeur inactive et inutilisée d'une metadonnée d'un gabarit de document ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"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":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonneeId":{"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"]},"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-document/{gabarit}/metadonnees/{metadonnee}/valeurs/{id}":{"delete":{"operationId":"supprimerValeurInactiveEnumMetadonneGabaritDocument","summary":"Suppression d'une valeur inactive et inutilisée d'une metadonnée d'un gabarit de document","tags":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"gabarit","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}},{"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/GabaritDeDocument"}}}},"400":{"description":"La valeur de l'enum de cette métadonnée est utilisée","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 document, 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_document_inexistant","metadonnee_inexistante","valeur_enum_metadonnee_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## GET /api/gabarits-de-document/{id}/documents > Lister les documents classés dans ce gabarit ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"GabaritDeDocument"},{"name":"Document"}],"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":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"Document":{"type":"object","required":["id","nom","mediaType","classe","preClasse","creeLe","misAJourLe","metadonnees","indexationDemandeeLe","indexeLe","empreinte","verrouille","versions","creePar"],"properties":{"id":{"$ref":"#/components/schemas/DocumentId"},"nom":{"type":"string"},"mediaType":{"type":"string","description":"Media type de la version la plus récente"},"classe":{"type":"boolean"},"preClasse":{"type":"boolean"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"dossier":{"$ref":"#/components/schemas/DossierId"},"bannette":{"$ref":"#/components/schemas/BannetteId"},"creeLe":{"type":"string","format":"date-time"},"misAJourLe":{"type":"string","format":"date-time"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"empreinte":{"type":"string","description":"Empreinte de la version la plus récente"},"verrouille":{"type":"boolean"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/Version"}},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"objetNumeriqueCCFN":{"type":"object","required":["objetNumerique","conteneur","empreinte","algorithmeEmpreinte","creeLe"],"properties":{"objetNumerique":{"type":"string","format":"uuid"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"},"empreinte":{"type":"string"},"algorithmeEmpreinte":{"type":"string"},"creeLe":{"type":"string","format":"date-time"}}},"suppressionPrevueLe":{"type":"string","format":"date-time"}}},"DocumentId":{"type":"string","format":"uuid"},"DossierId":{"type":"string","format":"uuid"},"BannetteId":{"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"},"Version":{"type":"object","required":["id","mediaType","empreinte","creeLe","nom"],"properties":{"id":{"$ref":"#/components/schemas/VersionId"},"mediaType":{"type":"string"},"empreinte":{"type":"string"},"creeLe":{"type":"string","format":"date-time"},"nom":{"type":"string"}}},"VersionId":{"type":"integer"},"ConteneurId":{"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-document/{id}/documents":{"get":{"operationId":"documents","summary":"Lister les documents classés dans ce gabarit","tags":["GabaritDeDocument","Document"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"description":"Un tableau JSON des documents classés","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}}},"206":{"description":"Un tableau JSON des documents pour la tranche demandée","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}},"headers":{"Content-Range":{"$ref":"#/components/headers/ContentRange"}}},"400":{"$ref":"#/components/responses/PaginationRangeErronee"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document 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_document_inexistant"]}}}}}},"416":{"$ref":"#/components/responses/PaginationImpossible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## Mise à jour de la DUC d'un gabarit de document > \## 🧪 Expérimental\ > \ > ⚠️ Cette API est encore à un stade expérimental, nous ne pouvons pas garantir la compatibilité avec de futures modifications ⚠️.\
```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"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":{"GabaritDeDocumentId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"},"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"]}}}}}},"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-document/{id}/duree-utilite-courante":{"put":{"operationId":"modifierDucGabaritDeDocument","summary":"Mise à jour de la DUC d'un gabarit de document","description":"## 🧪 Expérimental\n\n⚠️ Cette API est encore à un stade expérimental, nous ne pouvons pas garantir la compatibilité avec de futures modifications ⚠️.\n\n","tags":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"title":"DUC sur une métadonnée date d'un gabarit de dossier","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"}}}}},{"title":"DUC sur une métadonnée date d'un gabarit de document","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"}}}}},{"title":"DUC sur la date de création des document","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"]}}}}}]}}}},"responses":{"200":{"description":"DUC du gabarit de document modifié","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDocument"}}}},"400":{"description":"Le gabarit de document n'est pas dans un gabarit de dossier","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["format_payload_invalide","gabarit_de_document_hors_de_gabarit_de_dossier","metadonnee_non_date"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document ou la métadonnée n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit de document ou métadonnée inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_document_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}} ``` ## PUT /api/gabarits-de-document/{id}/duree-utilite-administrative > Mise à jour de la DUA d'un gabarit de document ```json {"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"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":{"GabaritDeDocumentId":{"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"}}},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"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"]}}}}}},"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-document/{id}/duree-utilite-administrative":{"put":{"operationId":"modifierDuaGabaritDeDocument","summary":"Mise à jour de la DUA d'un gabarit de document","tags":["GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du gabarit de document","required":true,"schema":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["duree","unite","metadonnee","sortFinal"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"type":"string","format":"uuid"},"sortFinal":{"type":"string","enum":["archivage","destruction"]}}}}}},"responses":{"200":{"description":"DUA du gabarit de document modifié","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDocument"}}}},"400":{"description":"Le gabarit de document n'est pas dans un gabarit de dossier","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["format_payload_invalide","gabarit_de_document_hors_de_gabarit_de_dossier","metadonnee_non_date","duc_requise_avant_de_definir_une_dua"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de document ou la métadonnée n'existe pas","content":{"application/json":{"schema":{"title":"Gabarit de document ou métadonnée inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_document_inexistant","metadonnee_inexistante"]}}}}}},"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/gabaritdedocument.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.