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

# Document

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

> Lister les processus attachés à ce document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"},"Processus":{"type":"object","required":["id","nom","document","attacheLe","creePar"],"properties":{"id":{"$ref":"#/components/schemas/ProcessusId"},"nom":{"type":"string"},"document":{"$ref":"#/components/schemas/DocumentId"},"attacheLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"detacheLe":{"type":"string","format":"date-time"}}},"ProcessusId":{"type":"integer"}},"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/documents/{id}/processus":{"get":{"operationId":"listerProcessus","summary":"Lister les processus attachés à ce document","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"200":{"description":"Un tableau JSON des processus attachés","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Processus"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Attacher un processus

> L'appel n'est possible que par ApiKey avec ou sans Impersonification

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"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`."}},"schemas":{"DocumentId":{"type":"string","format":"uuid"},"ProcessusId":{"type":"integer"},"Processus":{"type":"object","required":["id","nom","document","attacheLe","creePar"],"properties":{"id":{"$ref":"#/components/schemas/ProcessusId"},"nom":{"type":"string"},"document":{"$ref":"#/components/schemas/DocumentId"},"attacheLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"detacheLe":{"type":"string","format":"date-time"}}}},"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/documents/{id}/processus":{"post":{"operationId":"attacherProcessus","summary":"Attacher un processus","description":"L'appel n'est possible que par ApiKey avec ou sans Impersonification","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","nom"],"properties":{"id":{"$ref":"#/components/schemas/ProcessusId"},"nom":{"type":"string"}}}}}},"responses":{"201":{"description":"Le processus a été associé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Processus"}}}},"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":["format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"409":{"description":"Le processus n'est pas attachable","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille","processus_deja_attache"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Détacher un processus

> L'appel n'est possible que par ApiKey avec ou sans Impersonification

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"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`."}},"schemas":{"DocumentId":{"type":"string","format":"uuid"},"ProcessusId":{"type":"integer"},"Processus":{"type":"object","required":["id","nom","document","attacheLe","creePar"],"properties":{"id":{"$ref":"#/components/schemas/ProcessusId"},"nom":{"type":"string"},"document":{"$ref":"#/components/schemas/DocumentId"},"attacheLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"detacheLe":{"type":"string","format":"date-time"}}}},"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/documents/{id}/processus":{"delete":{"operationId":"detacherProcessus","summary":"Détacher un processus","description":"L'appel n'est possible que par ApiKey avec ou sans Impersonification","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/ProcessusId"}}}}}},"responses":{"200":{"description":"Le processus a été détaché","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Processus"}}}},"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":["format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document ou le processus n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","processus_inexistant"]}}}}}},"409":{"description":"Le document est verrouillé","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## GET /api/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":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"JwtOnlyOffice":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"JwtOnlyOffice":{"type":"apiKey","name":"authorization","in":"query","description":"Jwt généré par l'endpoint d'accès à OnlyOffice."},"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`."}},"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/documents/{id}/binaire":{"get":{"operationId":"binaire","summary":"Récupération du flux de données binaires liées au document","tags":["Document"],"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"}}}}}}
```

## POST /api/documents/{id}/binaire

> Remplacer le binaire d'un document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"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`."}},"schemas":{"DocumentId":{"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"}}},"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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"]}}}}}},"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/documents/{id}/binaire":{"post":{"operationId":"remplacerBinaire","summary":"Remplacer le binaire d'un document","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["fichier"],"properties":{"fichier":{"type":"string","description":"Le nouveau fichier à utiliser pour le document","format":"binary"}}}}}},"responses":{"200":{"description":"Le fichier a été remplacé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le fichier a été remplacé mais non habilité à le consulter"},"400":{"description":"Le fichier n'a pas été uploadé correctement","content":{"application/json":{"schema":{"title":"Erreur upload","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["erreur_upload"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"500":{"$ref":"#/components/responses/ErreurServeur"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

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

> Récupération des données binaires permettant de prévisualiser le document dans le navigateur web

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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/documents/{id}/previsualisation":{"get":{"operationId":"previsualiserDocument","summary":"Récupération des données binaires permettant de prévisualiser le document dans le navigateur web","tags":["Document"],"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 (ou encore en cours de traitement)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## GET /api/documents/{id}/versions/{version}/previsualisation

> Récupération des données binaires permettant de prévisualiser la version d'un document dans le navigateur web

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"},"VersionId":{"type":"integer"}},"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/documents/{id}/versions/{version}/previsualisation":{"get":{"operationId":"previsualiserVersionDocument","summary":"Récupération des données binaires permettant de prévisualiser la version d'un document dans le navigateur web","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}},{"in":"path","name":"version","description":"L'id de la version du document","required":true,"schema":{"$ref":"#/components/schemas/VersionId"}}],"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":"La version du document n'est pas prévisualisable dans un navigateur (ou encore en cours de traitement)"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"La version du document n'existe pas"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## GET /api/documents/{id}/versions/{version}/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":"Document"}],"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"},"VersionId":{"type":"integer"}},"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/documents/{id}/versions/{version}/binaire":{"get":{"operationId":"binaireVersion","summary":"Récupération du flux de données binaires liées au document","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}},{"in":"path","name":"version","description":"L'id de la version du document","required":true,"schema":{"$ref":"#/components/schemas/VersionId"}}],"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 ou la version n'existe pas"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Restaurer le document à cette version du binaire

> Les métadonnées ne sont pas affectées

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"},"VersionId":{"type":"integer"},"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"}}},"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"}}},"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/documents/{id}/versions/{version}/restauration":{"post":{"operationId":"restaurerVersion","summary":"Restaurer le document à cette version du binaire","description":"Les métadonnées ne sont pas affectées","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}},{"in":"path","name":"version","description":"L'id de la version du document","required":true,"schema":{"$ref":"#/components/schemas/VersionId"}}],"responses":{"200":{"description":"La version a été restaurée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"La version a été restaurée mais non habilité à consulter le document"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document ou la version n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","version_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## POST /api/documents/{id}/changement-bannette

> Déplacer un document non classé dans une autre 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":[]}],"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`."}},"schemas":{"DocumentId":{"type":"string","format":"uuid"},"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"}}},"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}/changement-bannette":{"post":{"operationId":"deplacerDocumentBannette","summary":"Déplacer un document non classé dans une autre bannette","tags":["Document","Bannette"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bannette"],"properties":{"bannette":{"$ref":"#/components/schemas/BannetteId"}}}}}},"responses":{"200":{"description":"Le document a été déplacé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été déplacé mais non habilité à le consulter"},"400":{"description":"Le document ne peut pas être déplacé","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_ne_peut_pas_etre_reclasse","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document ou la bannette n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","bannette_inexistante"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## POST /api/documents/{id}/reclassement

> Reclasser un document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[]},{"ApiKey":[],"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`."}},"schemas":{"DocumentId":{"type":"string","format":"uuid"},"GabaritDeDocumentId":{"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"},"DossierId":{"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"}}},"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":{"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/documents/{id}/reclassement":{"post":{"operationId":"reclasserDocument","summary":"Reclasser un document","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["gabarit","metadonnees"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/InputMetadonnee"}},"dossier":{"$ref":"#/components/schemas/DossierId"}}}}}},"responses":{"200":{"description":"Le document a été reclassé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été reclassé mais non habilité à consulter le 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_classe","classement_requiert_dossier","metadonnee_non_renseignee","format_valeur_metadonnee_invalide","modele_nom_dynamique_requis","classement_mauvais_dossier","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document, le gabarit de document ou le dossier n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","dossier_inexistant","gabarit_de_document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"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"]}}}}}}}}}}}
```

## POST /api/documents/{id}/changement-dossier

> Déplacer un document classé dans un autre dossier

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"},{"name":"Document"}],"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"},"DossierId":{"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"}}},"GabaritDeDocumentId":{"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}/changement-dossier":{"post":{"operationId":"deplacerDocumentDossier","summary":"Déplacer un document classé dans un autre dossier","tags":["Document","Dossier"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dossier"],"properties":{"dossier":{"$ref":"#/components/schemas/DossierId"}}}}}},"responses":{"200":{"description":"Le document a été déplacé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été déplacé mais non habilité à le consulter"},"400":{"description":"Le document ne peut pas être déplacé","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["classement_mauvais_dossier","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document ou le dossier cible n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","dossier_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Verrouiller un document

> Cela permet d'empêcher d'autres utilisateurs de modifier le document.

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"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`."}},"schemas":{"DocumentId":{"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"}}},"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}/verrouillage":{"post":{"operationId":"verrouillerDocument","summary":"Verrouiller un document","description":"Cela permet d'empêcher d'autres utilisateurs de modifier le document.","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"200":{"description":"Le document a été verrouillé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été verrouillé mais non habilité à le consulter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## DELETE /api/documents/{id}/verrouillage

> Déverrouiller un document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"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`."}},"schemas":{"DocumentId":{"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"}}},"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}/verrouillage":{"delete":{"operationId":"deverrouillerDocument","summary":"Déverrouiller un document","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"200":{"description":"Le document a été déverrouillé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été déverrouillé mais non habilité à le consulter"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Renommer un document

> Renommage d'un document, uniquement s'il n'est pas déjà classé

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"},"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"}}},"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"]}}}}}},"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/documents/{id}/renommage":{"post":{"operationId":"renommerDocument","summary":"Renommer un document","description":"Renommage d'un document, uniquement s'il n'est pas déjà classé","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"}}}}}},"responses":{"200":{"description":"Le document a été renommé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été renommé mais l'utilisateur n'est pas habilité à consulter le document"},"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","nom_encodage_invalide","nom_caracteres_controle_non_autorises","nom_unicode_non_normalise","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"409":{"description":"Le document est verrouillé par un autre utilisateur ou déjà classé","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille","document_deja_classe"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Classer un document dans un gabarit donné

> La clé \`dossier\` est nécessaire uniquement lorsque le document est à classer dans un dossier.

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"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`."}},"schemas":{"DocumentId":{"type":"string","format":"uuid"},"GabaritDeDocumentId":{"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"},"DossierId":{"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"}}},"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":{"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/documents/{id}/classement":{"post":{"operationId":"classerDocument","summary":"Classer un document dans un gabarit donné","description":"La clé `dossier` est nécessaire uniquement lorsque le document est à classer dans un dossier.","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["gabarit","metadonnees"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/InputMetadonnee"}},"dossier":{"$ref":"#/components/schemas/DossierId"}}}}}},"responses":{"200":{"description":"Le document a été classé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été classé mais non habilité à consulter le 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_ne_peut_pas_etre_reclasse","classement_requiert_dossier","metadonnee_non_renseignee","format_valeur_metadonnee_invalide","modele_nom_dynamique_requis","classement_mauvais_dossier","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document ou le gabarit de document n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","dossier_inexistant","gabarit_de_document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"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"]}}}}}}}}}}}
```

## Pré-classer un document dans un gabarit donné

> Si le document est déjà pré-classé alors toutes les métadonnées saisies seront perdues, même si le document est pré-classé dans le même gabarit de document.

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"},"GabaritDeDocumentId":{"type":"string","format":"uuid"},"DossierId":{"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"}}},"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}/pre-classement":{"post":{"operationId":"preClasser","summary":"Pré-classer un document dans un gabarit donné","description":"Si le document est déjà pré-classé alors toutes les métadonnées saisies seront perdues, même si le document est pré-classé dans le même gabarit de document.","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["gabarit"],"properties":{"gabarit":{"$ref":"#/components/schemas/GabaritDeDocumentId"},"dossier":{"$ref":"#/components/schemas/DossierId"}}}}}},"responses":{"200":{"description":"Le document a été pré-classé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le document a été pré-classé mais non habilité à le 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":["document_ne_peut_pas_etre_reclasse","classement_mauvais_dossier","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document ou le gabarit de document n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","dossier_inexistant","gabarit_de_document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## GET /api/documents/{id}

> Récupérer un document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"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`."}},"schemas":{"DocumentId":{"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"}}},"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"]}}}}}},"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/documents/{id}":{"get":{"operationId":"document","summary":"Récupérer un document","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"200":{"description":"Le document au format JSON","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## DELETE /api/documents/{id}

> Supprimer un document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}":{"delete":{"operationId":"supprimerDocument","summary":"Supprimer un document","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"204":{"description":"Le document a été supprimé"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## PUT /api/documents/{id}/metadonnees

> Modifier les métadonnées d'un document

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]},{"ApiKey":[],"Impersonification":[]},{"ApiKey":[]}],"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`."}},"schemas":{"DocumentId":{"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"}}},"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"}}},"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}/metadonnees":{"put":{"operationId":"modifierMetadonneesDocument","summary":"Modifier les métadonnées d'un document","tags":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InputMetadonnee"}}}}},"responses":{"200":{"description":"La métadonnée a été modifiée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Les métadonnées ont été modifiées mais non habilité à consulter le document"},"400":{"description":"La métadonnée est invalide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_non_classe","metadonnee_non_renseignee","format_valeur_metadonnee_invalide","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document ou une des métadonnées n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","metadonnee_inexistante"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Demander la suppression d'un document

> \## 🧪 Expérimental\
> \
> ⚠️ Cette API est encore à un stade expérimental, nous ne pouvons pas garantir la compatibilité avec de futures modifications ⚠️.\ <br>

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"},"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"}}},"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}/demande-suppression":{"post":{"operationId":"demanderSuppressionDocument","summary":"Demander la suppression d'un document","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":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"200":{"description":"La demande de suppression a été effectuée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"204":{"description":"Le demande de suppression a été effectuée mais non habilité à consulter"},"400":{"description":"Aucun délai de suppression n'est configuré","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["delai_suppression_non_configure"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Annuler la demande de suppression d'un document

> \## 🧪 Expérimental\
> \
> ⚠️ Cette API est encore à un stade expérimental, nous ne pouvons pas garantir la compatibilité avec de futures modifications ⚠️.\ <br>

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"},"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"}}},"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"]}}}}}},"DocumentVerrouille":{"description":"Le document est verrouillé par un autre utilisateur","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"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/documents/{id}/demande-suppression":{"delete":{"operationId":"annulerDemandeSuppression","summary":"Annuler la demande de suppression d'un document","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":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"responses":{"200":{"description":"La demande de suppression a été annulée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"400":{"description":"La demande de suppression n'est pas active","content":{"application/json":{"schema":{"title":"Demande invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_pas_en_instance_de_suppression"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le document n'existe pas","content":{"application/json":{"schema":{"title":"Document inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant"]}}}}}},"409":{"$ref":"#/components/responses/DocumentVerrouille"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```

## Dupliquer un document dans un ou plusieurs dossier

> \## 🧪 Expérimental\
> \
> ⚠️ Cette API est encore à un stade expérimental, nous ne pouvons pas garantir la compatibilité avec de futures modifications ⚠️.\ <br>

```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Document"}],"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"},"DossierId":{"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"}}},"GabaritDeDocumentId":{"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"]}}}}}},"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"]}}}}}},"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/documents/{id}/duplication":{"post":{"operationId":"dupliquerDocument","summary":"Dupliquer un document dans un ou plusieurs dossier","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":["Document"],"parameters":[{"in":"path","name":"id","description":"L'id du document","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dossiers"],"properties":{"dossiers":{"type":"array","items":{"$ref":"#/components/schemas/DossierId"},"description":"les ids des dossiers où dupliquer le document","minItems":1}}}}}},"responses":{"200":{"description":"Les documents dupliqués (consultables par l'utilisateur)","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}}},"400":{"description":"Requête invalide","content":{"application/json":{"schema":{"title":"Requête invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_ne_peut_etre_duplique_dans_dossier_avec_autre_gabarit","document_en_suppression_intermediaire_ne_peut_etre_duplique","document_non_classe_dans_dossier_ne_peut_etre_duplique"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Une des données est inexistante","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_inexistant","dossier_inexistant","gabarit_de_document_inexistant"]}}}}}},"409":{"description":"Le document n'est pas duplicable car il est verrouillé","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["document_verrouille"]}}}}}},"500":{"$ref":"#/components/responses/ErreurServeur"},"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/document.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.