> 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/dossier.md).
# Dossier
## GET /api/dossiers/{id}/liens
> Liste tous les contenus ciblés par des liens d'un dossier
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DossierId":{"type":"string","format":"uuid"},"LienVersGabaritDeDossierId":{"type":"string","format":"uuid"},"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"GabaritDeDossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"UtilisateurId":{"type":"string","format":"uuid"}},"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/dossiers/{id}/liens":{"get":{"operationId":"listerContenuCibléParLiensDuDossier","summary":"Liste tous les contenus ciblés par des liens d'un dossier","tags":["Dossier"],"parameters":[{"in":"path","name":"id","description":"L'id du dossier source","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}}],"responses":{"200":{"description":"Les dossiers ciblés","content":{"application/json":{"schema":{"type":"object","required":["liensVersDossiers"],"properties":{"liensVersDossiers":{"type":"array","items":{"type":"object","required":["lien","dossiers"],"properties":{"lien":{"$ref":"#/components/schemas/LienVersGabaritDeDossierId"},"dossiers":{"type":"array","items":{"$ref":"#/components/schemas/Dossier"}}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le dossier n'existe pas","content":{"application/json":{"schema":{"title":"Dossier inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["dossier_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## GET /api/dossiers/{id}
> Récupérer un dossier
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"}],"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":{"DossierId":{"type":"string","format":"uuid"},"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"GabaritDeDossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"UtilisateurId":{"type":"string","format":"uuid"}},"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/dossiers/{id}":{"get":{"operationId":"dossier","summary":"Récupérer un dossier","tags":["Dossier"],"parameters":[{"in":"path","name":"id","description":"L'id du dossier","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}}],"responses":{"200":{"description":"Un tableau JSON du dossier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dossier"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le dossier n'existe pas","content":{"application/json":{"schema":{"title":"Dossier inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["dossier_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## DELETE /api/dossiers/{id}
> Supprimer un dossier
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DossierId":{"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/dossiers/{id}":{"delete":{"operationId":"supprimerDossier","summary":"Supprimer un dossier","tags":["Dossier"],"parameters":[{"in":"path","name":"id","description":"L'id du dossier","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}}],"responses":{"204":{"description":"Le dossier a été supprimé"},"400":{"description":"Le dossier n'est pas vide","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["dossier_contient_des_elements","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le dossier n'existe pas","content":{"application/json":{"schema":{"title":"Dossier inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["dossier_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Sélectionner une valeur de filtre d'accès pour un dossier
> ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente du dossier et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\
> Utilisez l'endpoint \`/api/journal-taches\` pour suivre l'avancement.
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DossierId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"GabaritDeDossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"UtilisateurId":{"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/dossiers/{id}/filtres-acces/{filtre}":{"put":{"operationId":"selectionnerFiltreAccesDossier","summary":"Sélectionner une valeur de filtre d'accès pour un dossier","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente du dossier et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\nUtilisez l'endpoint `/api/journal-taches` pour suivre l'avancement.","tags":["Dossier"],"parameters":[{"in":"path","name":"id","description":"L'id du dossier","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}},{"in":"path","name":"filtre","description":"L'id du filtre d'accès","required":true,"schema":{"$ref":"#/components/schemas/FiltreAccesId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"description":"La valeur à sélectionner","type":"object","required":["valeurs"],"properties":{"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"},"description":"Le tableau ne peut contenir au maximum qu'une seule valeur, un tableau vide va supprimer la sélection"}}},{"description":"L'utilisateur à sélectionner","type":"object","required":["utilisateur"],"properties":{"utilisateur":{"type":"string","description":"Si la clé est `null` alors l'utilisateur sera désélectionné","format":"uuid","nullable":true}}}]}}}},"responses":{"200":{"description":"La valeur a été sélectionnée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dossier"}}}},"204":{"description":"La valeur a été sélectionnée mais non habilité à consulter le dossier"},"400":{"description":"La requête n'est pas valide","content":{"application/json":{"schema":{"title":"Ressource invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["filtre_acces_non_defini_sur_gabarit_de_dossier","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Une ressource n'existe pas","content":{"application/json":{"schema":{"title":"Ressource inexistante","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["dossier_inexistant","utilisateur_inexistant","filtre_acces_valeur_inexistante"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## GET /api/dossiers/{dossier}/documents
> Lister les documents d'un 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":[]},{"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":{"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"}}},"DocumentId":{"type":"string","format":"uuid"},"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"}},"parameters":{"Range":{"in":"header","name":"Range","description":"Header pour spécifier la tranche d'objets à sélectionner.\n\nSi aucune pagination n'est demandée la réponse contiendra au maximum `1000` objets, veuillez donc vérifier le code retour de la réponse pour vérifier si vous devez faire d'autres appels pour récupérer les autres objets.\n\nLa tranche maximum est de `1000` objets, si vous demandez plus alors la réponse contiendra au maximum `1000` objets. Il faut donc bien prendre en compte le header `Content-Range` contenu dans la réponse.","schema":{"type":"string","description":"Si vous voulez paginer par tranches de 10, il faudra utiliser les tranches `0-9`, `10-19`, `20-29`, etc...","pattern":"^resources (\\d+)-(\\d+)$"}}},"headers":{"ContentRange":{"schema":{"type":"string","description":"`Content-Range: 0-99/500` indique que la réponse contient les `100` premiers objets. Le header de réponse `Content-Range: 500-504/505` indique qu'on est arrivé à la fin"}}},"responses":{"PaginationRangeErronee":{"description":"Les bornes pour la pagination demandée sont erronées","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["erreur_borne_pagination"]},"message":{"type":"string"}}}}}},"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"PaginationImpossible":{"description":"La pagination demandée dépasse les données disponibles","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/dossiers/{dossier}/documents":{"get":{"operationId":"documentsDossier","summary":"Lister les documents d'un dossier","tags":["Dossier","Document"],"parameters":[{"in":"path","name":"dossier","description":"L'id du dossier","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"description":"La liste des documents","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}}},"206":{"description":"Un tableau JSON des documents pour la tranche demandée","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}},"headers":{"Content-Range":{"$ref":"#/components/headers/ContentRange"}}},"400":{"$ref":"#/components/responses/PaginationRangeErronee"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"416":{"$ref":"#/components/responses/PaginationImpossible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Modifier les métadonnées d'un dossier
> ⚠️ \*\*Attention\*\* : Cet endpoint déclenche une réindexation potentiellement conséquente du dossier et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\
> Utilisez l'endpoint \`/api/journal-taches\` pour suivre l'avancement.
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"}],"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":{"DossierId":{"type":"string","format":"uuid"},"InputMetadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"string","description":"L'id associé à la valeur prédéfinie choisie","format":"uuid"},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"GabaritDeDossierId":{"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"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"UtilisateurId":{"type":"string","format":"uuid"}},"responses":{"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"UnsupportedMediaType":{"description":"Le format de la requête n'est pas supporté","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/dossiers/{dossier}/metadonnees":{"put":{"operationId":"modifierMetadonneesDossier","summary":"Modifier les métadonnées d'un dossier","description":"⚠️ **Attention** : Cet endpoint déclenche une réindexation potentiellement conséquente du dossier et des documents contenus, impliquant une décorrélation temporaire des données de la recherche rapide.\nUtilisez l'endpoint `/api/journal-taches` pour suivre l'avancement.","tags":["Dossier"],"parameters":[{"in":"path","name":"dossier","description":"L'id du dossier","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InputMetadonnee"}}}}},"responses":{"200":{"description":"Les métadonnées ont été modifiées","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dossier"}}}},"204":{"description":"Les métadonnées ont été modifiées mais non habilité à consulter le dossier"},"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":["metadonnee_non_renseignee","format_valeur_metadonnee_invalide","format_payload_invalide"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le dossier 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":["dossier_inexistant","metadonnee_inexistante"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## POST /api/dossiers/{id}/fusion
> Fusionner deux dossiers ensemble
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DossierId":{"type":"string","format":"uuid"},"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"GabaritDeDossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"UtilisateurId":{"type":"string","format":"uuid"}},"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/dossiers/{id}/fusion":{"post":{"operationId":"fusionnerDossiers","summary":"Fusionner deux dossiers ensemble","tags":["Dossier"],"parameters":[{"in":"path","name":"id","description":"L'id du dossier cible","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"L'id du dossier source","type":"object","required":["source"],"properties":{"source":{"$ref":"#/components/schemas/DossierId"}}}}}},"responses":{"200":{"description":"Les dossiers ont été fusionnés","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dossier"}}}},"400":{"description":"Les gabarits de dossier des 2 dossiers diffèrent","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["gabarit_de_dossier_differents"]}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Un des dossiers n'existe pas","content":{"application/json":{"schema":{"title":"Dossier inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["dossier_inexistant"]}}}}}},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## Lister les documents archivés d'un dossier
> \## 🧪 Expérimental\
> \
> ⚠️ Cette API est encore à un stade expérimental, nous ne pouvons pas garantir la compatibilité avec de futures modifications ⚠️.\
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"},{"name":"Archivage"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DossierId":{"type":"string","format":"uuid"},"DocumentArchive":{"type":"object","required":["id","lot","mediaType","nom"],"properties":{"id":{"$ref":"#/components/schemas/DocumentArchiveId"},"lot":{"type":"object","required":["nom","archiveLe"],"properties":{"nom":{"type":"string"},"archiveLe":{"type":"string","format":"date-time"}}},"mediaType":{"type":"string"},"dossier":{"type":"object","required":["nom"],"properties":{"nom":{"type":"string"}}},"nom":{"type":"string"}}},"DocumentArchiveId":{"type":"string","format":"uuid"}},"parameters":{"Range":{"in":"header","name":"Range","description":"Header pour spécifier la tranche d'objets à sélectionner.\n\nSi aucune pagination n'est demandée la réponse contiendra au maximum `1000` objets, veuillez donc vérifier le code retour de la réponse pour vérifier si vous devez faire d'autres appels pour récupérer les autres objets.\n\nLa tranche maximum est de `1000` objets, si vous demandez plus alors la réponse contiendra au maximum `1000` objets. Il faut donc bien prendre en compte le header `Content-Range` contenu dans la réponse.","schema":{"type":"string","description":"Si vous voulez paginer par tranches de 10, il faudra utiliser les tranches `0-9`, `10-19`, `20-29`, etc...","pattern":"^resources (\\d+)-(\\d+)$"}}},"headers":{"ContentRange":{"schema":{"type":"string","description":"`Content-Range: 0-99/500` indique que la réponse contient les `100` premiers objets. Le header de réponse `Content-Range: 500-504/505` indique qu'on est arrivé à la fin"}}},"responses":{"PaginationRangeErronee":{"description":"Les bornes pour la pagination demandée sont erronées","content":{"application/json":{"schema":{"title":"Requete invalide","type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["erreur_borne_pagination"]},"message":{"type":"string"}}}}}},"Unauthorized":{"description":"Le JWT a expiré","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"NonHabilite":{"description":"L'utilisateur n'est pas habilité à faire l'action","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["non_habilite","changement_mot_de_passe_requis"]}}}}}},"PaginationImpossible":{"description":"La pagination demandée dépasse les données disponibles","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"ApiUnavailable":{"description":"L'api n'est actuellement pas disponible","content":{"application/json":{"schema":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["mise_a_jour_api_en_cours"]}}}}}}}},"paths":{"/api/dossiers/{id}/documents-archives":{"get":{"operationId":"documentsArchives","summary":"Lister les documents archivés d'un 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":["Dossier","Archivage"],"parameters":[{"in":"path","name":"id","description":"L'id du dossier cible","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}},{"$ref":"#/components/parameters/Range"}],"responses":{"200":{"description":"La liste des documents archivés","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentArchive"}}}}},"206":{"description":"Liste partielle des documents archivés","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentArchive"}}}},"headers":{"Content-Range":{"$ref":"#/components/headers/ContentRange"}}},"400":{"$ref":"#/components/responses/PaginationRangeErronee"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le dossier n'existe pas","content":{"application/json":{"schema":{"title":"Dossier inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["dossier_inexistant"]}}}}}},"416":{"$ref":"#/components/responses/PaginationImpossible"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
## PUT /api/dossiers/{id}/archivage
> Activer/désactiver l'archivage automatique du contenu d'un dossier
```json
{"openapi":"3.1.0","info":{"title":"Efalia Doc","version":"1.0.0"},"tags":[{"name":"Dossier"},{"name":"Admin"}],"servers":[{"url":"https://interne.efalia.cloud:1202/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"}},"schemas":{"DossierId":{"type":"string","format":"uuid"},"Dossier":{"type":"object","required":["id","nom","gabarit","metadonnees","indexationDemandeeLe","indexeLe","creeLe","creePar","misAJourLe","filtresAcces","archiverLeContenu"],"properties":{"id":{"$ref":"#/components/schemas/DossierId"},"nom":{"type":"string"},"gabarit":{"$ref":"#/components/schemas/GabaritDeDossierId"},"metadonnees":{"type":"array","items":{"$ref":"#/components/schemas/Metadonnee"}},"indexationDemandeeLe":{"type":"string","format":"date-time","nullable":true},"indexeLe":{"type":"string","format":"date-time","nullable":true},"creeLe":{"type":"string","format":"date-time"},"creePar":{"type":"object","required":["nomComplet"],"properties":{"nomComplet":{"type":"string"}},"nullable":true},"misAJourLe":{"type":"string","format":"date-time","nullable":true},"filtresAcces":{"type":"array","items":{"oneOf":[{"type":"object","required":["filtre","valeurs"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"valeurs":{"type":"array","items":{"$ref":"#/components/schemas/FiltreAccesValeurId"}}}},{"type":"object","required":["filtre","utilisateur"],"properties":{"filtre":{"$ref":"#/components/schemas/FiltreAccesId"},"utilisateur":{"$ref":"#/components/schemas/UtilisateurId"}}}]}},"archiverLeContenu":{"type":"boolean"}}},"GabaritDeDossierId":{"type":"string","format":"uuid"},"Metadonnee":{"type":"object","required":["structure","valeur"],"properties":{"structure":{"$ref":"#/components/schemas/StructureMetadonneeId"},"valeur":{"$ref":"#/components/schemas/ValeurMetadonnee"}}},"StructureMetadonneeId":{"type":"string","format":"uuid"},"ValeurMetadonnee":{"oneOf":[{"type":"string","description":"La valeur peut être n'importe quelle `string` pour les format `texte` et `paragraphe`. Le format `date` peut être une `string` respectant le schéma `Y-m-d`."},{"type":"number","description":"La valeur peut être soit un `int` soit un `float`"},{"type":"boolean"},{"type":"array","items":{"type":"object","required":["id","valeur"],"properties":{"id":{"$ref":"#/components/schemas/ValeurMetadonneeId"},"valeur":{"type":"string"}}},"description":"Ce type de donnée n'est à utiliser qu'avec le format `enum`"}],"nullable":true},"ValeurMetadonneeId":{"type":"string","format":"uuid"},"FiltreAccesId":{"type":"string","format":"uuid"},"FiltreAccesValeurId":{"type":"string","format":"uuid"},"UtilisateurId":{"type":"string","format":"uuid"}},"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/dossiers/{id}/archivage":{"put":{"operationId":"activerArchivageDossier","summary":"Activer/désactiver l'archivage automatique du contenu d'un dossier","tags":["Dossier","Admin"],"parameters":[{"in":"path","name":"id","description":"L'id du dossier","required":true,"schema":{"$ref":"#/components/schemas/DossierId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean"}}}}}},"responses":{"200":{"description":"L'option a été modifiée","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dossier"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/NonHabilite"},"404":{"description":"Le gabarit de dossier n'existe pas","content":{"application/json":{"schema":{"title":"Dossier inexistant","type":"object","required":["message","code"],"properties":{"message":{"type":"string"},"code":{"type":"string","enum":["dossier_inexistant"]}}}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"503":{"$ref":"#/components/responses/ApiUnavailable"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://documentation.efalia.com/api-reference/efalia-doc-api/dossier.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.