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

# Models

## The ArmoireId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ArmoireId":{"type":"string","format":"uuid"}}}}
```

## The Armoire object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Armoire":{"type":"object","required":["id","nom","idExterne","indexationDemandeeLe"],"properties":{"id":{"$ref":"#/components/schemas/ArmoireId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true}}},"ArmoireId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255}}}}
```

## The BannetteId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"BannetteId":{"type":"string","format":"uuid"}}}}
```

## The Bannette object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Bannette":{"type":"object","required":["id","nom","indexationDemandeeLe","rechercheDansContenu","idExterne","versionnementActive"],"properties":{"id":{"$ref":"#/components/schemas/BannetteId"},"nom":{"type":"string"},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"rechercheDansContenu":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"versionnementActive":{"type":"boolean"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}},"BannetteId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"ConteneurId":{"type":"string","format":"uuid"}}}}
```

## The GabaritDeDocumentId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"GabaritDeDocumentId":{"type":"string","format":"uuid"}}}}
```

## The GabaritDeDocument object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"GabaritDeDocument":{"type":"object","required":["id","nom","description","idExterne","modeleNomDynamique","metadonnees","indexationDemandeeLe","rechercheDansContenu","versionnementActive"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"nom":{"type":"string"},"description":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"gabaritDeDossier":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"rechercheDansContenu":{"type":"boolean"},"groupement":{"type":"object","required":["metadonnee"],"properties":{"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"},"periode":{"type":"string","enum":["annee-mois","annee"]}}},"dureeUtiliteCourante":{"oneOf":[{"type":"object","required":["gabaritDeDossier"],"properties":{"gabaritDeDossier":{"type":"object","required":["duree","unite","metadonnee"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},{"type":"object","required":["gabaritDeDocument"],"properties":{"gabaritDeDocument":{"type":"object","required":["duree","unite","metadonnee"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},{"type":"object","required":["dateDeCreationDocument"],"properties":{"dateDeCreationDocument":{"type":"object","required":["duree","unite"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]}}}}}]},"dureeUtiliteAdministrative":{"type":"object","required":["duree","unite","metadonnee","sortFinal"],"properties":{"duree":{"type":"integer","minimum":1,"maximum":100},"unite":{"type":"string","enum":["mois","annee"]},"metadonnee":{"type":"string"},"sortFinal":{"type":"string","enum":["destruction","archivage"]}}},"versionnementActive":{"type":"boolean"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"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"}}}}
```

## The GabaritDeDossierId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"GabaritDeDossierId":{"type":"string","format":"uuid"}}}}
```

## The GabaritDeDossier object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"GabaritDeDossier":{"type":"object","required":["id","nom","idExterne","modeleNomDynamique","description","armoire","metadonnees","indexationDemandeeLe","filtresAcces"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"modeleNomDynamique":{"type":"string"},"description":{"type":"string"},"armoire":{"$ref":"#/components/schemas/ArmoireId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/StructureMetadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}},"GabaritDeDossierId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonnee":{"type":"object","required":["id","format","libelle","aide","obligatoire","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/StructureMetadonneeId"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"libelle":{"type":"string"},"aide":{"type":"string"},"obligatoire":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string","maxLength":255},"active":{"type":"boolean"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"description":"Cette clé n'est présente que si le format est `enum`"},"choixMultiple":{"type":"boolean","description":"Cette clé n'est présente que si le format est `enum`"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"}}}}
```

## The StructureMetadonnee object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"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"]},"idExterne":{"type":"string","maxLength":255},"ValeurMetadonneeId":{"type":"string","format":"uuid"}}}}
```

## The StructureMetadonneeId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"StructureMetadonneeId":{"type":"string","format":"uuid"}}}}
```

## The ValeurMetadonneeId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ValeurMetadonneeId":{"type":"string","format":"uuid"}}}}
```

## The MetadonneeFormat object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]}}}}
```

## The ConteneurId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ConteneurId":{"type":"string","format":"uuid"}}}}
```

## The Conteneur object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Conteneur":{"type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/ConteneurId"},"nom":{"type":"string"}}},"ConteneurId":{"type":"string","format":"uuid"}}}}
```

## The DocumentArchiveId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"DocumentArchiveId":{"type":"string","format":"uuid"}}}}
```

## The DocumentId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"DocumentId":{"type":"string","format":"uuid"}}}}
```

## The Document object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"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"},"GabaritDeDocumentId":{"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"}}}}
```

## The DocumentArchive object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"DocumentArchive":{"type":"object","required":["id","lot","mediaType","nom"],"properties":{"id":{"$ref":"#/components/schemas/DocumentArchiveId"},"lot":{"type":"object","required":["nom","archiveLe"],"properties":{"nom":{"type":"string"},"archiveLe":{"type":"string","format":"date-time"}}},"mediaType":{"type":"string"},"dossier":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"}}},"nom":{"type":"string"}}},"DocumentArchiveId":{"type":"string","format":"uuid"}}}}
```

## The VersionId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"VersionId":{"type":"integer"}}}}
```

## The Version object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"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"}}}}
```

## The Echantillon object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Echantillon":{"type":"object","required":["id","recherche","creeLe"],"properties":{"id":{"$ref":"#/components/schemas/EchantillonId"},"recherche":{"type":"object","properties":{"lot":{"type":"string"},"dossier":{"type":"string"},"document":{"type":"string"},"archiveLe":{"type":"object","required":["avant"],"properties":{"avant":{"type":"string","format":"date-time"},"apres":{"type":"string","format":"date-time"}}}}},"creeLe":{"type":"string","format":"date-time"}}},"EchantillonId":{"type":"string","format":"uuid"}}}}
```

## The EchantillonId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"EchantillonId":{"type":"string","format":"uuid"}}}}
```

## The DossierId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"DossierId":{"type":"string","format":"uuid"}}}}
```

## The Dossier object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"DossierId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"UtilisateurId":{"type":"string","format":"uuid"}}}}
```

## The Metadonnee object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"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"}}}}
```

## The ValeurRechercheMetadonnee object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ValeurRechercheMetadonnee":{"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`. Le format enum est un uuid"},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`. Il est possible de rechercher des `float` jusqu'à 4 chiffres après la virgule."},{"type":"boolean"}]}}}}
```

## The ValeurRechercheDonneeSysteme object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ValeurRechercheDonneeSysteme":{"type":"string","format":"date"}}}}
```

## The ValeurMetadonnee object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"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"}}}}
```

## The JournalEntreeId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"JournalEntreeId":{"type":"string","format":"uuid"}}}}
```

## The JournalEntree object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"JournalEntree":{"type":"object","required":["id","auteur","message","dateDeCreation"],"properties":{"id":{"$ref":"#/components/schemas/JournalEntreeId"},"auteur":{"type":"string"},"message":{"type":"string"},"dateDeCreation":{"type":"string","format":"date-time"}}},"JournalEntreeId":{"type":"string","format":"uuid"}}}}
```

## The JournalTacheEntree object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"JournalTacheEntree":{"type":"object","required":["nom","creeLe","termineLe","enErreurLe","messageErreur"],"properties":{"nom":{"type":"string"},"creeLe":{"type":"string","format":"date-time"},"termineLe":{"type":"string","format":"date-time","nullable":true},"enErreurLe":{"type":"string","format":"date-time","nullable":true},"messageErreur":{"type":"string","nullable":true}}}}}}
```

## The DemandeArchivageId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"DemandeArchivageId":{"type":"string","format":"uuid"}}}}
```

## The DemandeArchivage object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"DemandeArchivage":{"type":"object","required":["id","nom","effectueLe"],"properties":{"id":{"$ref":"#/components/schemas/DemandeArchivageId"},"nom":{"type":"string"},"effectueLe":{"type":"string","format":"date-time"}}},"DemandeArchivageId":{"type":"string","format":"uuid"}}}}
```

## The ResultatRecherche object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ResultatRecherche":{"type":"object","required":["id","nom","mediaType","metadonnees"],"properties":{"id":{"$ref":"#/components/schemas/DocumentId"},"nom":{"type":"string"},"mediaType":{"type":"string"},"gabarit":{"description":"Peut ne pas être présent dans le cas où le document n'est pas encore classé","type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"nom":{"type":"string"}}},"armoire":{"description":"Peut ne pas être présent dans le cas où le document n'est pas encore classé","type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/ArmoireId"},"nom":{"type":"string"}}},"bannette":{"description":"Peut ne pas être présent dans le cas où le document est déjà classé","type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/BannetteId"},"nom":{"type":"string"}}},"dossier":{"description":"Peut ne pas être présent dans le cas où le document n'est pas classé dans un dossier (ou encore dans une bannette)","type":"object","required":["id","nom","gabarit"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"}}}}},"metadonnees":{"type":"array","items":{"type":"object","required":["structure","libelle","format","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"libelle":{"type":"string"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}}}}},"DocumentId":{"type":"string","format":"uuid"},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"ArmoireId":{"type":"string","format":"uuid"},"BannetteId":{"type":"string","format":"uuid"},"DossierId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"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"}}}}
```

## The ResultatRechercheDossier object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ResultatRechercheDossier":{"type":"object","required":["id","nom","gabarit","armoire","metadonnees"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"}}},"armoire":{"type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/ArmoireId"},"nom":{"type":"string"}}},"metadonnees":{"type":"array","items":{"type":"object","required":["structure","libelle","format","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"libelle":{"type":"string"},"format":{"$ref":"#/components/schemas/MetadonneeFormat"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}}},"suppressionPrevueLe":{"type":"string","format":"date-time"}}},"DossierId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"type":"string","format":"uuid"},"ArmoireId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]},"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"}}}}
```

## The InputMetadonnee object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"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"}}}}
```

## The UtilisateurId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"UtilisateurId":{"type":"string","format":"uuid"}}}}
```

## The Utilisateur object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Utilisateur":{"type":"object","required":["id","identifiant","nomComplet","email","estAdministrateur","estActif","roles","vientDuLdap","vientDeMgLogin","filtresAcces","doitChangerMotDePasse","licencePcuAttribuee"],"properties":{"id":{"$ref":"#/components/schemas/UtilisateurId"},"identifiant":{"type":"string"},"nomComplet":{"type":"string"},"email":{"type":"string"},"estAdministrateur":{"type":"boolean"},"estActif":{"type":"boolean"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleId"}},"vientDuLdap":{"type":"boolean"},"vientDeMgLogin":{"type":"boolean"},"filtresAcces":{"type":"array","items":{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},"description":"Les filtres sans valeur n'apparaissent pas"},"doitChangerMotDePasse":{"type":"boolean"},"licencePcuAttribuee":{"type":"boolean"}}},"UtilisateurId":{"type":"string","format":"uuid"},"RoleId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"}}}}
```

## The RoleId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"RoleId":{"type":"string","format":"uuid"}}}}
```

## The Role object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Role":{"type":"object","required":["id","nom","armoires"],"properties":{"id":{"$ref":"#/components/schemas/RoleId"},"nom":{"type":"string"},"armoires":{"type":"array","items":{"$ref":"#/components/schemas/ArmoireId"}}}},"RoleId":{"type":"string","format":"uuid"},"ArmoireId":{"type":"string","format":"uuid"}}}}
```

## The Droit object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Droit":{"type":"string","enum":["consulter","supprimer","modifier","diffuser","ajouter"]}}}}
```

## The HabilitationsArmoireRequest object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"HabilitationsArmoireRequest":{"type":"object","required":["gabaritsDeDossier","gabaritsDeDocument"],"properties":{"gabaritsDeDossier":{"type":"array","items":{"type":"object","required":["gabarit","droits"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"droits":{"type":"array","items":{"$ref":"#/components/schemas/Droit"}}}}},"gabaritsDeDocument":{"type":"array","items":{"type":"object","required":["gabarit","droits"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"droits":{"type":"array","items":{"$ref":"#/components/schemas/Droit"}}}}}}},"GabaritDeDossierId":{"type":"string","format":"uuid"},"Droit":{"type":"string","enum":["consulter","supprimer","modifier","diffuser","ajouter"]},"GabaritDeDocumentId":{"type":"string","format":"uuid"}}}}
```

## The HabilitationsArmoire object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"HabilitationsArmoire":{"type":"object","required":["gabaritsDeDossier","gabaritsDeDocument"],"properties":{"gabaritsDeDossier":{"type":"array","items":{"type":"object","required":["gabarit","droits","filtresAcces"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"droits":{"type":"array","items":{"$ref":"#/components/schemas/Droit"}},"filtresAcces":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesId"}}}}},"gabaritsDeDocument":{"type":"array","items":{"type":"object","required":["gabarit","droits"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"droits":{"type":"array","items":{"$ref":"#/components/schemas/Droit"}}}}}}},"GabaritDeDossierId":{"type":"string","format":"uuid"},"Droit":{"type":"string","enum":["consulter","supprimer","modifier","diffuser","ajouter"]},"FiltreAccesId":{"type":"string","format":"uuid"},"GabaritDeDocumentId":{"type":"string","format":"uuid"}}}}
```

## The HabilitationsBannettes object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"HabilitationsBannettes":{"type":"array","items":{"type":"object","required":["bannette","droits"],"properties":{"bannette":{"$ref":"#/components/schemas/BannetteId"},"droits":{"type":"array","items":{"$ref":"#/components/schemas/Droit"}}}}},"BannetteId":{"type":"string","format":"uuid"},"Droit":{"type":"string","enum":["consulter","supprimer","modifier","diffuser","ajouter"]}}}}
```

## The idExterne object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"idExterne":{"type":"string","maxLength":255}}}}
```

## The CategorieDeGabaritsDeDocumentId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"CategorieDeGabaritsDeDocumentId":{"type":"string","format":"uuid"}}}}
```

## The CategorieDeGabaritsDeDocument object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"CategorieDeGabaritsDeDocument":{"type":"object","required":["id","nom","idExterne"],"properties":{"id":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"},"nom":{"type":"string"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}},"CategorieDeGabaritsDeDocumentId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255}}}}
```

## The LienVersGabaritDeDossierId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"LienVersGabaritDeDossierId":{"type":"string","format":"uuid"}}}}
```

## The LienVersGabaritDeDossier object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"LienVersGabaritDeDossier":{"type":"object","required":["id","gabarit","metadonnee"],"properties":{"id":{"$ref":"#/components/schemas/LienVersGabaritDeDossierId"},"gabarit":{"type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/GabaritDeDossierId"},"nom":{"type":"string"}}},"metadonnee":{"type":"object","required":["source","cible"],"properties":{"source":{"$ref":"#/components/schemas/StructureMetadonneeId"},"cible":{"$ref":"#/components/schemas/StructureMetadonneeId"}}}}},"LienVersGabaritDeDossierId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"type":"string","format":"uuid"},"StructureMetadonneeId":{"type":"string","format":"uuid"}}}}
```

## The InputGabaritDeDocument object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"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"}}}}
```

## The InputGabaritDeDossier object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"InputGabaritDeDossier":{"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à"}}}}}},"idExterne":{"type":"string","maxLength":255},"MetadonneeFormat":{"type":"string","enum":["texte","paragraphe","numerique","date","bool","enum"]}}}}
```

## The FiltreAccesId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"FiltreAccesId":{"type":"string","format":"uuid"}}}}
```

## The FiltreAccesValeurId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"FiltreAccesValeurId":{"type":"string","format":"uuid"}}}}
```

## The FiltreAcces object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"FiltreAcces":{"type":"object","required":["id","nom","type","valeurs"],"properties":{"id":{"$ref":"#/components/schemas/FiltreAccesId"},"nom":{"type":"string"},"type":{"type":"string","enum":["liste_utilisateurs","liste_valeurs"]},"valeurs":{"type":"array","items":{"type":"object","required":["id","valeur","active"],"properties":{"id":{"$ref":"#/components/schemas/FiltreAccesValeurId"},"valeur":{"type":"string"},"active":{"type":"boolean"}}},"description":"Cette liste est toujours vide lorsque le filtre référence les utilisateurs"}}},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"}}}}
```

## The ProcessusId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ProcessusId":{"type":"integer"}}}}
```

## The Processus object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"Processus":{"type":"object","required":["id","nom","document","attacheLe","creePar"],"properties":{"id":{"$ref":"#/components/schemas/ProcessusId"},"nom":{"type":"string"},"document":{"$ref":"#/components/schemas/DocumentId"},"attacheLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"detacheLe":{"type":"string","format":"date-time"}}},"ProcessusId":{"type":"integer"},"DocumentId":{"type":"string","format":"uuid"}}}}
```

## The ClePubliqueId object

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"components":{"schemas":{"ClePubliqueId":{"type":"string","format":"uuid"}}}}
```


---

# 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/models.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.