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

# Bannette

## GET /api/bannettes

> Lister les bannettes

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Bannette"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiPublicKey":[],"Impersonification":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"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"}},"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/bannettes":{"get":{"operationId":"bannettes","summary":"Lister les bannettes","tags":["Bannette"],"responses":{"200":{"description":"Un tableau JSON des bannettes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Bannette"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## POST /api/bannettes

> Créer une bannette

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Bannette"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiPublicKey":[],"Impersonification":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"schemas":{"ConteneurId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"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"}},"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/bannettes":{"post":{"operationId":"creerBannette","summary":"Créer une bannette","tags":["Bannette","Admin"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nom","rechercheDansContenu"],"properties":{"nom":{"type":"string"},"rechercheDansContenu":{"type":"boolean","description":"Cette clé n'est nécessaire que pour activer la recherche dans le contenu des documents"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"},"idExterne":{"$ref":"#/components/schemas/idExterne"}}}}}},"responses":{"201":{"description":"Bannette créée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bannette"}}}},"400":{"description":"Le nom est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["nom_obligatoire","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Mise à jour de la bannette

> ⚠️ \*\*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":"Bannette"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiPublicKey":[],"Impersonification":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"schemas":{"BannetteId":{"type":"string","format":"uuid"},"ConteneurId":{"type":"string","format":"uuid"},"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"}}},"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/bannettes/{id}":{"put":{"operationId":"modifierBannette","summary":"Mise à jour de la bannette","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":["Bannette","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la bannette","required":true,"schema":{"$ref":"#/components/schemas/BannetteId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"},"rechercheDansContenu":{"type":"boolean","description":"Désactiver la recherche dans le contenu n'affectera que les futurs ajout à la bannette. 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},"conteneur":{"$ref":"#/components/schemas/ConteneurId"}}}}}},"responses":{"200":{"description":"Bannette modifiée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bannette"}}}},"400":{"description":"Le nom est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["nom_obligatoire","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La bannette n'existe pas","content":{"application/json":{"schema":{"title":"Bannette inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["bannette_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## DELETE /api/bannettes/{id}

> Supprimer une bannette

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Bannette"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiPublicKey":[],"Impersonification":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"schemas":{"BannetteId":{"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/bannettes/{id}":{"delete":{"operationId":"supprimerBannette","summary":"Supprimer une bannette","tags":["Bannette","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la bannette","required":true,"schema":{"$ref":"#/components/schemas/BannetteId"}}],"responses":{"204":{"description":"Bannette supprimée"},"400":{"description":"La bannette contient encore des documents","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["bannette_contient_des_elements","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La bannette n'existe pas","content":{"application/json":{"schema":{"title":"Bannette inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["bannette_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## PUT /api/bannettes/{id}/id-externe

> Mise à jour de l'id externe de la bannette

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Bannette"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiPublicKey":[],"Impersonification":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"schemas":{"BannetteId":{"type":"string","format":"uuid"},"idExterne":{"type":"string","maxLength":255},"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"}}},"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/bannettes/{id}/id-externe":{"put":{"operationId":"modifierIdExterneBannette","summary":"Mise à jour de l'id externe de la bannette","tags":["Bannette","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la bannette","required":true,"schema":{"$ref":"#/components/schemas/BannetteId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idExterne"],"properties":{"idExterne":{"$ref":"#/components/schemas/idExterne"}}}}}},"responses":{"200":{"description":"Bannette modifiée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bannette"}}}},"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":["id_externe_trop_long","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La bannette n'existe pas","content":{"application/json":{"schema":{"title":"Bannette inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["bannette_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## PUT /api/bannettes/{id}/recherche-dans-contenu

> Activer/désactiver la recherche dans le contenu des documents d'une bannette

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Bannette"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiPublicKey":[],"Impersonification":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"schemas":{"BannetteId":{"type":"string","format":"uuid"},"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"}}},"idExterne":{"type":"string","maxLength":255},"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/bannettes/{id}/recherche-dans-contenu":{"put":{"operationId":"activerRechercheDansContenuPourUneBannette","summary":"Activer/désactiver la recherche dans le contenu des documents d'une bannette","tags":["Bannette","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la bannette","required":true,"schema":{"$ref":"#/components/schemas/BannetteId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Désactiver la recherche dans le contenu n'affectera que les futurs ajout à la bannette"}}}}}},"responses":{"200":{"description":"Bannette modifiée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bannette"}}}},"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":"La bannette n'existe pas","content":{"application/json":{"schema":{"title":"Bannette inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["bannette_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## GET /api/bannettes/{id}/documents

> Lister les documents présents dans la bannette

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Bannette"},{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]},{"ApiPublicKey":[],"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`."},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"schemas":{"BannetteId":{"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"},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"DossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"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/bannettes/{id}/documents":{"get":{"operationId":"documentsBannette","summary":"Lister les documents présents dans la bannette","tags":["Bannette","Document"],"parameters":[{"in":"path","name":"id","description":"L'id de la bannette","required":true,"schema":{"$ref":"#/components/schemas/BannetteId"}},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"description":"Un tableau JSON des documents","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"},"416":{"$ref":"#/components/responses/PaginationImpossible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## POST /api/bannettes/{id}/upload

> Créer un document dans une bannette

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Bannette"},{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]},{"ApiPublicKey":[],"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`."},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"schemas":{"BannetteId":{"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"},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"DossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"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/bannettes/{id}/upload":{"post":{"operationId":"uploaderDocument","summary":"Créer un document dans une bannette","tags":["Bannette","Document"],"parameters":[{"in":"path","name":"id","description":"L'id de la bannette","required":true,"schema":{"$ref":"#/components/schemas/BannetteId"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["fichier","nom"],"properties":{"fichier":{"type":"string","description":"Le fichier à uploader","format":"binary"},"nom":{"type":"string"}}}}}},"responses":{"201":{"description":"Le document a été uploadé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été uploadé mais non habilité à consulter"},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["nom_origine_obligatoire","nom_origine_encodage_invalide","nom_origine_caracteres_controle_non_autorises","nom_origine_unicode_non_normalise","format_payload_invalide","erreur_upload","erreur_depot_efalia_safe"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La bannette n'existe pas","content":{"application/json":{"schema":{"title":"Bannette inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["bannette_inexistante"]}}}}}},"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"]}}}}}}}}}}}
```

## PUT /api/bannettes/{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":"Bannette"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiPublicKey":[],"Impersonification":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiPublicKey":{"type":"apiKey","name":"x-api-public-key","in":"header","description":"Clé d'API publique"}},"schemas":{"BannetteId":{"type":"string","format":"uuid"},"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"}}},"idExterne":{"type":"string","maxLength":255},"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/bannettes/{id}/versionnement":{"put":{"operationId":"activerVersionnementBannette","summary":"Activer/désactiver le versionnement des binaires d'un document","tags":["Bannette","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la bannnette","required":true,"schema":{"$ref":"#/components/schemas/BannetteId"}}],"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/Bannette"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La bannette n'existe pas","content":{"application/json":{"schema":{"title":"Bannette inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["bannette_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/bannette.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.