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

# Technique

## GET /api/sauvegarde/fichiers

> Sauvegarde des fichiers

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Technique"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"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/sauvegarde/fichiers":{"get":{"operationId":"archiveFichiers","summary":"Sauvegarde des fichiers","tags":["Technique","Admin"],"responses":{"200":{"description":"L'archive de tous les fichiers","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## GET /api/sauvegarde/base-de-donnees

> Sauvegarde de la base de données

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Technique"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"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/sauvegarde/base-de-donnees":{"get":{"operationId":"archiveBaseDonnees","summary":"Sauvegarde de la base de données","tags":["Technique","Admin"],"responses":{"200":{"description":"Le dump sql de la base de données","content":{"application/gzip":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## POST /api/mise-a-jour-automatique

> Lance la mise à jour automatique de l'application

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Technique"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"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/mise-a-jour-automatique":{"post":{"operationId":"miseAJour","summary":"Lance la mise à jour automatique de l'application","tags":["Technique","Admin"],"responses":{"202":{"description":"La mise à jour est lancée (mais pas forcément terminée)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## GET /ping

> Endpoint pour savoir si l'API est disponible

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Technique"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[],"paths":{"/ping":{"get":{"operationId":"ping","summary":"Endpoint pour savoir si l'API est disponible","tags":["Technique"],"responses":{"200":{"description":"L'API est disponible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}},"components":{"responses":{"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"]}}}}}}}}}
```

## GET /configuration

> Informations publiques de configuration de l'instance test

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Technique"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[],"paths":{"/configuration":{"get":{"operationId":"configuration","summary":"Informations publiques de configuration de l'instance test","tags":["Technique"],"responses":{"200":{"description":"Configuration de l'instance","content":{"application/json":{"schema":{"type":"object","required":["apparence"],"properties":{"apparence":{"type":"object","required":["theme"],"properties":{"theme":{"type":"string","enum":["MG_Docs","Efalia_Doc","DocumentHUB"]}}},"mglogin":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"suite":{"type":"object","properties":{"capture":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"compose":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"process":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"safe":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"tracking":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}}}},"efaliaCapture":{"type":"object","required":["templatesUrlFlux"],"properties":{"templatesUrlFlux":{"type":"object","properties":{"bannetteSansCodeBarres":{"type":"string"},"bannetteAvecCodeBarres":{"type":"string"},"dossierSansCodeBarres":{"type":"string"},"dossierAvecCodeBarres":{"type":"string"}}}}},"efaliaProcess":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"webhooks":{"type":"array","items":{"type":"object","required":["type","url","libelle","message"],"properties":{"type":{"type":"string","enum":["ADMIN","ARMOIRE","BANNETTE","DOC_SINGLE","DOC_MULTIPLE","DOSSIER","USER"]},"url":{"type":"string"},"libelle":{"type":"string"},"message":{"type":"string"}}}},"onlyOffice":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"securite":{"type":"object","required":["motDePasse"],"properties":{"motDePasse":{"type":"object","required":["tailleMinimum"],"properties":{"tailleMinimum":{"type":"integer","minimum":1}}}}},"suppressionIntermediaire":{"type":"object","required":["delaiDocuments"],"properties":{"delaiDocuments":{"type":"object","properties":{"bannettes":{"type":"integer","minimum":1},"dossiers":{"type":"integer","minimum":1},"racineArmoire":{"type":"integer","minimum":1}}}}}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}},"components":{"responses":{"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"]}}}}}}}}}
```

## GET /api/journal-taches/{dateDeDebut}/{dateDeFin}

> Lister les entrées du journal des tâches traitées en asynchrone sur une période donnée

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Technique"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"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+)$"}}},"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}}}},"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":{"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/journal-taches/{dateDeDebut}/{dateDeFin}":{"get":{"operationId":"journalTachesParPeriode","summary":"Lister les entrées du journal des tâches traitées en asynchrone sur une période donnée","tags":["Technique","Admin"],"parameters":[{"in":"path","name":"dateDeDebut","description":"Début de la période souhaitée","required":true,"schema":{"type":"string","format":"date"}},{"in":"path","name":"dateDeFin","description":"Fin de la période souhaitée","required":true,"schema":{"type":"string","format":"date"}},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"description":"Un tableau JSON des entrées du journal pour la période demandée","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JournalTacheEntree"}}}}},"206":{"description":"Un tableau JSON des entrées du journal pour la période et tranche demandée","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JournalTacheEntree"}}}},"headers":{"Content-Range":{"$ref":"#/components/headers/ContentRange"}}},"400":{"description":"Requete invalide","content":{"application/json":{"schema":{"title":"Requête invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["erreur_borne_periode","erreur_borne_pagination"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"416":{"$ref":"#/components/responses/PaginationImpossible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## GET /api/journal-taches

> Lister les entrées du journal des tâches traitées en asynchrone

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Technique"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"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+)$"}}},"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}}}},"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/journal-taches":{"get":{"operationId":"journalTaches","summary":"Lister les entrées du journal des tâches traitées en asynchrone","tags":["Technique","Admin"],"parameters":[{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"description":"Un tableau JSON des entrées du journal des tâches","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JournalTacheEntree"}}}}},"206":{"description":"Un tableau JSON des entrées du journal pour la tranche demandée","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JournalTacheEntree"}}}},"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"}}}}}}
```


---

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