14.3 Création d'un fichier
14.3.1 Url
- Création d'un fichier
POST /api/v1/temporaryFiles/
Ce fichier est temporairement stocké dans le vault. S'il n'est pas associé à un
document, le fichier temporaire est supprimé au bout d'une période définie par
le paramètre applicatif CORE_TMPDIR_MAXAGE
.
14.3.2 Content
14.3.2.1 Format urlEncoded
Le contenu de la requête contient une variable (type file) contenant le contenu du fichier
-----------------------------70122309720638098951066485136 Content-Disposition: form-data; name="fi_file"; filename="my_file.jpeg" Content-Type: image/jpeg ...
Le type de la requête est application/x-www-form-urlencoded
.
Ce format peut être utilisé directement depuis un formulaire HTML.
14.3.2.2 Utilisation d'une requête ajax
L'envoi du fichier peut aussi être fait en javascript via l'objet
FormData
.
var fd = new FormData(); fd.append('myFile', myFile); // myFile objet de type File $.ajax({ type: 'POST', url: "api/v1/temporaryFiles/", processData: false, contentType: false, cache: false, data: fd});
Tous les navigateurs ne supportent
pas l'objet FormData
.
14.3.3 Structure de retour
Le retour est une donnée JSON.
14.3.3.1 En cas de réussite :
La partie data
contient un objet file
:
-
file.uri
: uri d'accès à la nouvelle ressource -
file.reference
: référence pouvant être utilisant comme valeur dans un attribut de type file ou image. -
file.size
: Taille du fichier en octets -
file.fileName
: Nom du fichier (basename) -
file.mime
: Type mime (système) -
file.cdate
: Date de création -
file.mdate
: Date de modification -
file.downloadUrl
: Url de téléchargement du fichier
- Exemple, création d'un fichier temporaire
{"success" : true, "messages" : [], "data" : { "file" : { cdate: "2016-08-30 11:41:45" downloadUrl: "api/v1/images/recorded/original/8878229557124583290.png" fileName: "une-fourmis-panda-ark.jpg" iconUrl: "api/v1/images/assets/sizes/20/mime-image.png" id: "8878229557124583290" mime: "image/jpeg" reference: "image/jpeg|8878229557124583290|une-fourmis-panda-ark.jpg" size: "102997" thumbnailUrl: "api/v1/images/recorded/sizes/48/8878229557124583290.png" } }, "exceptionMessage" : "", "headers" : [] }
14.3.4 Utilisation
Une fois le fichier ajouté, il peut être associé à un document en indiquant sa
référence dans la valeur d'un attribut de type file
comme tout autre attribut
en utilisant :
- soit la création de document,
- soit la modification de document.
C'est la propriété reference
qui doit être affectée à la valeur de l'attribut
fichier.