> 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/archivage.md).
# Archivage
## Lister les demandes d'archive
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"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"}},"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/archivage/demandes":{"get":{"operationId":"listerDemandesArchive","summary":"Lister les demandes d'archive","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"responses":{"200":{"description":"Un tableau JSON des demandes d'archive","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DemandeArchivage"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Demander une archive
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"ArmoireId":{"type":"string","format":"uuid"},"GabaritDeDossierId":{"type":"string","format":"uuid"},"CategorieDeGabaritsDeDocumentId":{"type":"string","format":"uuid"},"GabaritDeDocumentId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expirĂ©","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilitĂ© Ă faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"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/archivage/demandes":{"post":{"operationId":"demanderArchive","summary":"Demander une archive","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["armoire"],"properties":{"armoire":{"$ref":"#/components/schemas/ArmoireId"}}},{"type":"object","required":["gabaritDeDossier"],"properties":{"gabaritDeDossier":{"$ref":"#/components/schemas/GabaritDeDossierId"}}},{"type":"object","required":["categorie"],"properties":{"categorie":{"$ref":"#/components/schemas/CategorieDeGabaritsDeDocumentId"}}},{"type":"object","required":["gabaritDeDocument"],"properties":{"gabaritDeDocument":{"$ref":"#/components/schemas/GabaritDeDocumentId"}}}]}}}},"responses":{"202":{"description":"La demande Ă Ă©tĂ© faite"},"400":{"description":"Le gabarit de document n'est pas dans un gabarit de dossier","content":{"application/json":{"schema":{"title":"Gabarit de document hors d'un gabarit de dossier","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_document_hors_de_gabarit_de_dossier"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Armoire, gabarit de dossier, catĂ©gorie ou gabarit de document inexistant","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["armoire_inexistante","gabarit_de_dossier_inexistant","categorie_gabarits_de_document_inexistante","gabarit_de_document_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Valider une demande d'archivage
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DemandeArchivageId":{"type":"string","format":"uuid"},"DocumentId":{"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/archivage/demandes/{id}/validation":{"post":{"operationId":"validerDemandeArchivage","summary":"Valider une demande d'archivage","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la demande","required":true,"schema":{"$ref":"#/components/schemas/DemandeArchivageId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["documents"],"properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentId"}}}}}}},"responses":{"204":{"description":"La demande a Ă©tĂ© validĂ©e"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La demande d'archivage n'existe pas","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["demande_archivage_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Annuler une demande d'archivage
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DemandeArchivageId":{"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/archivage/demandes/{id}":{"delete":{"operationId":"annulerDemandeArchivage","summary":"Annuler une demande d'archivage","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la demande","required":true,"schema":{"$ref":"#/components/schemas/DemandeArchivageId"}}],"responses":{"204":{"description":"La demande a Ă©tĂ© annulĂ©e"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La demande d'archivage n'existe pas","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["demande_archivage_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Lister les documents d'une demande d'archivage
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
> \
> Ce endpoint n'est pas paginĂ© car seul 100 documents maximum peuvent ĂȘtre retournĂ©s
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DemandeArchivageId":{"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"},"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"}},"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/archivage/demandes/{id}/documents":{"get":{"operationId":"listerDocumentsDemandeArchive","summary":"Lister les documents d'une demande d'archivage","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\nCe endpoint n'est pas paginĂ© car seul 100 documents maximum peuvent ĂȘtre retournĂ©s","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de la demande d'archivage","required":true,"schema":{"$ref":"#/components/schemas/DemandeArchivageId"}}],"responses":{"200":{"description":"Un tableau JSON des documents de la demande d'archivage","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La demande n'existe pas","content":{"application/json":{"schema":{"title":"Demande d'archivage inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string","title":"Demande d'archivage non trouvĂ©e"},"code":{"type":"string","enum":["demande_archivage_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Rechercher les documents archivés
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
> \
> La recherche des documents archivés se fait avec un ET sur ses critÚres
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"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":{"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"}},"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"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requĂȘte n'est pas supportĂ©","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"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/archivage/recherche":{"post":{"operationId":"rechercherArchivage","summary":"Rechercher les documents archivĂ©s","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\nLa recherche des documents archivĂ©s se fait avec un ET sur ses critĂšres","tags":["Archivage","Admin"],"parameters":[{"$ref":"#/components/parameters/Range"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"recherche":{"type":"string","minLength":3},"lot":{"title":"nom","description":"La recherche est faite avec un startWith","type":"object","required":["nom"],"properties":{"nom":{"type":"string","minLength":1}}},"dossier":{"title":"dossier","description":"La recherche est faite avec un startWith","type":"object","required":["nom"],"properties":{"nom":{"type":"string","minLength":1}}},"document":{"title":"document","description":"La recherche est faite avec un startWith","type":"object","required":["nom"],"properties":{"nom":{"type":"string","minLength":1}}},"archiveLe":{"type":"object","required":["avant"],"properties":{"avant":{"type":"string","format":"date"},"apres":{"type":"string","format":"date"}}}}}}}},"responses":{"200":{"description":"Un tableau JSON des documents archivĂ©s","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentArchive"}}}}},"206":{"description":"Un tableau JSON des documents archivĂ©s par tranche demandĂ©e","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentArchive"}}}},"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"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"416":{"$ref":"#/components/responses/PaginationImpossible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Lister les Ă©chantillons
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"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"}},"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/archivage/echantillons":{"get":{"operationId":"listerEchantillons","summary":"Lister les Ă©chantillons","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"responses":{"200":{"description":"Un tableau JSON des Ă©chantillons","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Echantillon"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Créer un échantillon de documents archivés
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"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"}},"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/archivage/echantillons":{"post":{"operationId":"creerEchantillon","summary":"CrĂ©er un Ă©chantillon de documents archivĂ©s","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"lot":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"}}},"dossier":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"}}},"document":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"}}},"archiveLe":{"type":"object","required":["avant"],"properties":{"avant":{"type":"string","format":"date"},"apres":{"type":"string","format":"date"}}}}}}}},"responses":{"201":{"description":"Echantillon crĂ©Ă©","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Echantillon"}}}},"400":{"description":"L'Ă©chantillon n'a pas de critĂšre","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["critere_echantillon_non_renseignee","echantillon_vide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Supprimer un Ă©chantillon ainsi que les documents qu'il contient
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"EchantillonId":{"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/archivage/echantillons/{id}/destruction":{"post":{"operationId":"detruireEchantillon","summary":"Supprimer un Ă©chantillon ainsi que les documents qu'il contient","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de l'Ă©chantillon","required":true,"schema":{"$ref":"#/components/schemas/EchantillonId"}}],"responses":{"204":{"description":"L'Ă©chantillon a Ă©tĂ© supprimĂ©"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"L'Ă©chantillon n'existe pas","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["echantillon_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Supprimer un Ă©chantillon
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"EchantillonId":{"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/archivage/echantillons/{id}":{"delete":{"operationId":"supprimerEchantillon","summary":"Supprimer un Ă©chantillon","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de l'Ă©chantillon","required":true,"schema":{"$ref":"#/components/schemas/EchantillonId"}}],"responses":{"204":{"description":"L'Ă©chantillon a Ă©tĂ© supprimĂ©"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"L'Ă©chantillon n'existe pas","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["echantillon_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Lister les documents d'un Ă©chantillon
> \## đ§Ș ExpĂ©rimental\
> \
> â ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"EchantillonId":{"type":"string","format":"uuid"},"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"}},"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"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requĂȘte n'est pas supportĂ©","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"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/archivage/echantillons/{id}/documents":{"get":{"operationId":"listerDocumentsEchantillon","summary":"Lister les documents d'un Ă©chantillon","description":"## đ§Ș ExpĂ©rimental\n\nâ ïžâŻCette API est encore Ă un stade expĂ©rimental, nous ne pouvons pas garantir la compatibilitĂ© avec de futures modificationsâŻâ ïž.\n\n","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id de l'Ă©chantillon","required":true,"schema":{"$ref":"#/components/schemas/EchantillonId"}},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"description":"Un tableau JSON des documents archivĂ©s de l'Ă©chantillon","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentArchive"}}}}},"206":{"description":"Un tableau JSON des documents archivĂ©s de l'Ă©chantillon par tranche demandĂ©e","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentArchive"}}}},"headers":{"Content-Range":{"$ref":"#/components/headers/ContentRange"}}},"400":{"$ref":"#/components/responses/PaginationRangeErronee"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"L'Ă©chantillon n'existe pas","content":{"application/json":{"schema":{"title":"Echantillon inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string","title":"Echantillon non trouvĂ©"},"code":{"type":"string","enum":["echantillon_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"416":{"$ref":"#/components/responses/PaginationImpossible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## POST /api/archivage/documents/{id}/restauration
> Restaurer un document en archive intermédiaire
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DocumentArchiveId":{"type":"string","format":"uuid"},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"DossierId":{"type":"string","format":"uuid"},"InputMetadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"oneOf":[{"type":"string","description":"La valeur peut ĂȘtre n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut ĂȘtre une `string` respectant le schĂ©ma `Y-m-d`."},{"type":"number","description":"La valeur peut ĂȘtre soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"string","description":"L'id associĂ© Ă la valeur prĂ©dĂ©finie choisie","format":"uuid"},"description":"Ce type de donnĂ©e n'est Ă utiliser qu'avec le format `enum`"}],"nullable":true}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"Document":{"type":"object","required":["id","nom","mediaType","classe","preClasse","creeLe","misAJourLe","metadonnees","indexationDemandeeLe","indexeLe","empreinte","verrouille","versions","creePar"],"properties":{"id":{"$ref":"#/components/schemas/DocumentId"},"nom":{"type":"string"},"mediaType":{"type":"string","description":"Media type de la version la plus rĂ©cente"},"classe":{"type":"boolean"},"preClasse":{"type":"boolean"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"dossier":{"$ref":"#/components/schemas/DossierId"},"bannette":{"$ref":"#/components/schemas/BannetteId"},"creeLe":{"type":"string","format":"date-time"},"misAJourLe":{"type":"string","format":"date-time"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"empreinte":{"type":"string","description":"Empreinte de la version la plus rĂ©cente"},"verrouille":{"type":"boolean"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/Version"}},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"objetNumeriqueCCFN":{"type":"object","required":["objetNumerique","conteneur","empreinte","algorithmeEmpreinte","creeLe"],"properties":{"objetNumerique":{"type":"string","format":"uuid"},"conteneur":{"$ref":"#/components/schemas/ConteneurId"},"empreinte":{"type":"string"},"algorithmeEmpreinte":{"type":"string"},"creeLe":{"type":"string","format":"date-time"}}},"suppressionPrevueLe":{"type":"string","format":"date-time"}}},"DocumentId":{"type":"string","format":"uuid"},"BannetteId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut ĂȘtre n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut ĂȘtre une `string` respectant le schĂ©ma `Y-m-d`."},{"type":"number","description":"La valeur peut ĂȘtre soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnĂ©e n'est Ă utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"Version":{"type":"object","required":["id","mediaType","empreinte","creeLe","nom"],"properties":{"id":{"$ref":"#/components/schemas/VersionId"},"mediaType":{"type":"string"},"empreinte":{"type":"string"},"creeLe":{"type":"string","format":"date-time"},"nom":{"type":"string"}}},"VersionId":{"type":"integer"},"ConteneurId":{"type":"string","format":"uuid"}},"responses":{"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/archivage/documents/{id}/restauration":{"post":{"operationId":"restaurerDocumentArchive","summary":"Restaurer un document en archive intermĂ©diaire","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentArchiveId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["gabarit","metadonnees"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"dossier":{"$ref":"#/components/schemas/DossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/InputMetadonnee"}}}}}}},"responses":{"200":{"description":"La document a Ă©tĂ© restaurĂ©","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"400":{"description":"Le payload est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_doit_d_abord_etre_archive","restauration_requiert_dossier","metadonnee_non_renseignee","format_valeur_metadonnee_invalide","modele_nom_dynamique_requis","restauration_mauvais_dossier","format_payload_invalide","document_dans_echantillon"]}}}}}},"404":{"description":"Le document, le gabarit de document ou le dossier n'existe pas","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","dossier_inexistant","gabarit_de_document_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## GET api/archivage/documents/{id}/binaire
> Récupération du flux de données binaires liées au document
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DocumentId":{"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/archivage/documents/{id}/binaire":{"get":{"operationId":"binaireDocumentarchive","summary":"Récupération du flux de données binaires liées au document","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"200":{"description":"Le contenu binaire du fichier","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## GET /api/archivage/documents/{id}/previsualisation
> Récupération des données binaires permettant de prévisualiser le document archivé dans le navigateur web
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Admin"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DocumentId":{"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/archivage/documents/{id}/previsualisation":{"get":{"operationId":"previsualiserDocumentArchive","summary":"RĂ©cupĂ©ration des donnĂ©es binaires permettant de prĂ©visualiser le document archivĂ© dans le navigateur web","tags":["Archivage","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"200":{"description":"Le contenu binaire du fichier visualisable. Techniquement le binaire peut ĂȘtre une image ou un pdf","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"204":{"description":"Le document n'est pas prĂ©visualisable dans un navigateur"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas"},"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/archivage.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.