API pour la gestion des ressources
Les portails permettent d’héberger des fichiers sous forme de ressources, pour des documents, images, à rendre disponibles aux usagers.
Ajout et modification d’une ressource
Sur /api/assets/set/IDENTFIANT-DE-RESSOURCE/, via la méthode HTTP POST; l’identifiant de la ressource est libre, il est commun d’utiliser un système à préfixe, par exemple "description-poste:345". Si l’identifiant n’est pas connu une nouvelle ressource sera créée, s’il est connu le fichier associé sera remplacé par le nouveau contenu.
Paramètre JSON, corps de la requête
|
Nom |
Description |
Obligatoire |
|---|---|---|
|
|
Fichier à poser sur cette ressource; ce paramètre contient des sous-clés : content (contenu du fichier encodé en base64, content_type (type MIME du fichier, optionnel), filename (nom du fichier, optionnel). |
Oui |
Format de retour
Une réponse JSON est retournée dont les entrées sont les suivantes
|
Nom |
Description |
Exemple |
|---|---|---|
|
|
Succès de l’opération |
0 si ok, 1 en cas d’erreur |
|
|
En cas de succès, l’adresse de la ressource publiée |
|
Suppression d’une ressource
Sur /api/assets/delete/IDENTFIANT-DE-RESSOURCE/, via la méthode HTTP POST. Sans paramètres.
La méthode réussit toujours, que la ressource existe ou pas.
Seule l’association de l’identifiant à la ressource nommée est retirée, le fichier en lui-même n’est pas supprimé du disque.