# Fichiers
Cette collection décrit l'accès aux fichiers contenu dans les Smart Elements.
# URL
L'URL d'accès est: /api/v2/smart-elements/<docid>/files/<attrid>/<index>
# Méthodes
La collection files implémente les éléments suivants:
- Collection
| Action | URL | Action effectuée |
|---|---|---|
| GET | /api/v2/smart-elements/<docid>/files/<attrid>/<index>/<fileName> | Télécharge un fichier d'un Smart Field de type file ou image |
| POST | /api/v2/temporaryFiles/ | N/A |
| PUT | /api/v2/temporaryFiles/ | N/A |
| DELETE | /api/v2/temporaryFiles/ | N/A |
# Téléchargement d'un fichier de Smart Element
# URL
Pour des Smart Fields inclus dans un tableau, l'index indique le rang dans le tableau:
GET /api/v2/smart-elements/<docid>/files/<attrid>/<index>.
Téléchargement du fichier associé au Smart Field attrid du Smart Element docid.
L'index index facultatif vaut -1 pour les Smart Fields fichier non contenu dans un tableau.
Dans le cas, d'un Smart Field inclus dans un tableau, l'index contient le rang dans le tableau de fichier. 0 indique
la première rangée.
Si l'index n'est pas indiqué pour un Smart Field inclus dans un tableau, alors l'ensemble des fichiers sera téléchargé dans une archive "zip". Les fichiers sont alors numérotés suivant l'ordre du tableau.
Ce fichier est extrait du vault.
Pour accéder au fichier, le droit view sur le document est vérifié. De plus, si le Smart Field est en visibilité "I" alors le téléchargement du fichier ne sera pas autorisé.
# Structure de retour
# En cas de réussite
Le retour est le contenu du fichier.
# En cas d'échec
En cas d'échec, une structure JSON est retournée avec l'erreur si aucune extension n'est indiquée dans l'URL. Si une extension (différente de json) est indiquée alors l'erreur affiché sera un texte brut.
Les raisons d'échecs spécifiques à cette requête sont:
| Raison | Status HTTP | Code d'erreur |
|---|---|---|
| Impossible de télécharger le fichier, le Smart Field indiqué n'existe pas | 400 | ROUTES0116 |
Aucune image dans le Smart Field attrid | 404 File not found | ROUTES0118 |
| L'identifiant de l'image n'existe pas dans le Smart Field | 404 File not found | ROUTES0119 |
| Erreur sur la valeur du Smart Field | 400 | ROUTES0120 |
| Index incorrect, le Smart Field est dans un tableau (index >= 0) | 400 | ROUTES0121 |
| Index incorrect, le Smart Field n'est pas dans un tableau (index = -1) | 400 | ROUTES0122 |
| Index incorrect, le Smart Field existe dans le Smart Element (index >= -1) | 400 | ROUTES0123 |
Le Smart Field indiqué n'est pas de type file ou image | 400 | ROUTES0124 |
| Smart Element non trouvé | 404 | CRUD0200 |
| Privilège insuffisant pour accéder au Smart Element | 403 Forbidden | CRUD0201 |
| Smart Element non trouvé | 404 | CRUD0221 |
| Erreur sur la valeur du Smart Field | 400 | CRUD0609 |
| Impossible de créer l'archive zip | 400 | CRUD0615 |
# Paramètres
Le paramètre inline permet de modifier l'entête HTTP pour demander au navigateur un téléchargement de fichier ou un
affichage dans le navigateur dans le cas où celui-ci permet son affichage.
Par défaut, le téléchargement est demandé; l'entête contient: Content-Disposition: attachment.
Si inline vaut true,yes ou 1, la disposition vaut: Content-Disposition: inline.