9.5 Créer un tag utilisateur

9.5.1 URL

POST /api/v1/documents/<documentId>/usertags/<tagid>

Création du tag tagid pour document documentId. Le tag est associé à l'utilisateur connecté.

Exemple :

POST /api/v1/documents/my_document/usertags/my_custom

Le droit de modifier le document n'est pas requis pour ajouter un tag. Seul le droit de consulter le document est requis.

9.5.2 Content

Le contenu contient la valeur du tag. Si elle est vide la valeur sera égale à la chaîne vide.

Si le contenu est une structure json, la valeur retournée sera une structure.

9.5.3 Structure de retour

Le retour est une donnée JSON.

9.5.3.1 En cas de réussite :

La partie data contient 2 champs :

1. uri : URI préférentielle d'accès à la ressource;
2. userTag : liste des valeurs des propriétés;

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": "Hello"
        }
    }
}

9.5.3.2 En cas d'échec

Les raisons d'échecs spécifiques à cette requête sont

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]"
}