> 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/categoriesdegabaritsdedocument.md).

# CategoriesDeGabaritsDeDocument

## PUT /api/categories-de-gabarits-de-document/{id}

> Renommer une catégorie de gabarits de document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"CategoriesDeGabaritsDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"CategorieDeGabaritsDeDocumentId":{"type":"string","format":"uuid"},"CategorieDeGabaritsDeDocument":{"type":"object","required":["id","nom","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"idExterne":{"type":"string","maxLength":255}},"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/categories-de-gabarits-de-document/{id}":{"put":{"operationId":"renommerCategorieGabaritDocument","summary":"Renommer une catégorie de gabarits de document","tags":["CategoriesDeGabaritsDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la catégorie de gabarits de document","required":true,"schema":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"}}}}}},"responses":{"200":{"description":"La catégorie a été renommée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocument"}}}},"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","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La catégorie de gabarits de document","content":{"application/json":{"schema":{"title":"Categorie gabarit document inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["categorie_gabarits_de_document_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## DELETE /api/categories-de-gabarits-de-document/{id}

> Supprimer une catégorie de gabarits de document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"CategoriesDeGabaritsDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"CategorieDeGabaritsDeDocumentId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"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/categories-de-gabarits-de-document/{id}":{"delete":{"operationId":"supprimerCategorieGabaritDocument","summary":"Supprimer une catégorie de gabarits de document","tags":["CategoriesDeGabaritsDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la catégorie de gabarits de document","required":true,"schema":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"}}],"responses":{"204":{"description":"La catégorie a été supprimée"},"400":{"description":"La catégorie contient encore des gabarits","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["categorie_de_gabarits_de_document_contient_des_elements"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La catégorie de gabarits de document n'existe pas","content":{"application/json":{"schema":{"title":"Categorie inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["categorie_gabarits_de_document_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## PUT /api/categories-de-gabarits-de-document/{id}/id-externe

> Modifier l'id externe d'une catégorie de gabarits de document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"CategoriesDeGabaritsDeDocument"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"CategorieDeGabaritsDeDocumentId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"CategorieDeGabaritsDeDocument":{"type":"object","required":["id","nom","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}}},"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/categories-de-gabarits-de-document/{id}/id-externe":{"put":{"operationId":"modifierIdExterneCategorieGabaritDocument","summary":"Modifier l'id externe d'une catégorie de gabarits de document","tags":["CategoriesDeGabaritsDeDocument","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la catégorie de gabarits de document","required":true,"schema":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idExterne"],"properties":{"idExterne":{"$ref":"#/components/schemas/idExterne"}}}}}},"responses":{"200":{"description":"L'id externe a été modifié","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocument"}}}},"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":"La catégorie de gabarits de document","content":{"application/json":{"schema":{"title":"Categorie gabarit document inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["categorie_gabarits_de_document_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## POST /api/categories-de-gabarits-de-document/{categorie}/gabarits-de-document

> Créer un gabarit de document dans une catégorie

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"CategoriesDeGabaritsDeDocument"},{"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":{"CategorieDeGabaritsDeDocumentId":{"type":"string","format":"uuid"},"InputGabaritDeDocument":{"type":"object","required":["nom","description","metadonnees"],"properties":{"nom":{"type":"string"},"description":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"metadonnees":{"type":"array","items":{"type":"object","required":["format","libelle","aide","obligatoire"],"properties":{"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["valeur"],"properties":{"valeur":{"type":"string","description":"Une des valeurs possibles de la liste"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé ne s'applique que pour le format `enum`, elle est obligatoire dans ce cas-là"},"choixMultiple":{"type":"boolean","description":"Cette clé ne s'applique que pour le format `enum`, elle est obligatoire dans ce cas-là"}}}},"rechercheDansContenu":{"type":"boolean","description":"Cette propriété n'est utile que lorsqu'on veut activer la recherche dans le contenu (par défaut c'est désactivé)"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}},"idExterne":{"type":"string","maxLength":255},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ConteneurId":{"type":"string","format":"uuid"},"GabaritDeDocument":{"type":"object","required":["id","nom","description","idExterne","modeleNomDynamique","metadonnees","indexationDemandeeLe","rechercheDansContenu","versionnementActive"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"nom":{"type":"string"},"description":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"gabaritDeDossier":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"rechercheDansContenu":{"type":"boolean"},"groupement":{"type":"object","required":["metadonnee"],"properties":{"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"},"periode":{"type":"string","enum":["annee-mois","annee"]}}},"dureeUtiliteCourante":{"oneOf":[{"type":"object","required":["gabaritDeDossier"],"properties":{"gabaritDeDossier":{"type":"object","required":["duree","unite","metadonnee"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},{"type":"object","required":["gabaritDeDocument"],"properties":{"gabaritDeDocument":{"type":"object","required":["duree","unite","metadonnee"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},{"type":"object","required":["dateDeCreationDocument"],"properties":{"dateDeCreationDocument":{"type":"object","required":["duree","unite"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]}}}}}]},"dureeUtiliteAdministrative":{"type":"object","required":["duree","unite","metadonnee","sortFinal"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"type":"string"},"sortFinal":{"type":"string","enum":["destruction","archivage"]}}},"versionnementActive":{"type":"boolean"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"ArmoireId":{"type":"string","format":"uuid"},"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"}},"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/categories-de-gabarits-de-document/{categorie}/gabarits-de-document":{"post":{"operationId":"creerGabaritDocumentCategorie","summary":"Créer un gabarit de document dans une catégorie","tags":["CategoriesDeGabaritsDeDocument","GabaritDeDocument","Admin"],"parameters":[{"in":"path","name":"categorie","description":"L'id de la catégorie de gabarits de document","required":true,"schema":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputGabaritDeDocument"}}}},"responses":{"201":{"description":"Le nouveau gabarit de document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GabaritDeDocument"}}}},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["libelle_obligatoire","libelle_trop_long","description_trop_longue","au_moins_un_parametre_substitutif_requis_dans_modele_nom_dynamique","liste_predefinie_vide","format_payload_invalide","format_enum_sans_liste_predefinie","id_externe_trop_long"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La catégorie n'existe pas","content":{"application/json":{"schema":{"title":"Categorie gabarit document inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["categorie_gabarits_de_document_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/categoriesdegabaritsdedocument.md?ask=<question>&goal=<endgoal>
```

`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.