9.6 Modifier un tag utilisateur
9.6.1 URL
PUT /api/v1/documents/<documentId>/usertags/<tagid>
Modification du tag tagid du document documentId pour l'utilisateur
connecté.
Exemple :
PUT /api/v1/documents/my_document/usertags/my_custom
Si le tag n'existe déjà, il est créé.
9.6.2 Content
Le contenu contient la valeur du tag.
Si il est vide la valeur est égale à la chaîne vide.
Si le contenu est une structure JSON, la valeur retournée est une structure.
9.6.3 Structure de retour
Le retour est une donnée JSON.
9.6.3.1 En cas de réussite :
La partie data contient 2 champs :
-
uri: URI préférentielle d'accès à la ressource; -
userTag: liste des valeurs du tag;
Exemple :
{ "success": true, "messages": [], "data": { "uri": "http://www.example.net/api/v1/documents/34757/usertags/test", "userTag": { "id": "test", "date": "2015-01-08 14:58:27", "value": { "first":"Interesting", "second" : 123.56 } } } }
9.6.3.2 En cas d'échec
Les raisons d'échecs spécifiques à cette requête sont
| Raison | Status HTTP | Error Code |
|---|---|---|
| Privilège insuffisant pour accéder au document | 403 | CRUD0201 |
| Document supprimé | 404 | CRUD0108 |
Exemple :
Cas d'erreur de privilège
{"success" : false, "messages" : [ { "type" : "error", "contentText" : "Document \"1051\" access deny : Pas de privil\u00e8ge view pour le document famille [1051]", "contentHtml" : "", "code" : "API0201", "uri" : "", "data" : null } ], "data" : null, "exceptionMessage" : "Document \"1051\" access deny : Pas de privil\u00e8ge view pour le document famille [1051]" }