9.4 Récupérer un tag utilisateur

9.4.1 URL

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

Récupération du tag tagid du document documentId de l'utilisateur connecté.

Exemple :

GET /api/v1/documents/my_document/usertags/my_custom

9.4.2 Content

Le contenu de la requête est vide.

9.4.3 Structure de retour

Le retour est une donnée JSON.

9.4.3.1 En cas de réussite :

La partie data contient 2 champs :

uri : URI préférentielle d'accès à la ressource;
userTag : Propriétés du tag
1. id : identifiant du tag (les identifiants sont sensible à la casse),
2. date : date de pose du tag,
3. value : valeur du tag. La valeur peut avoir 3 formes :
  1. String : Pour les données chaîne (ex : Hello world)
  2. Numerique : Pour les données numériques (ex : 123.34)
  3. Objet : Pour les données compatibles JSON (ex : {"one": 12, "two":"Hello"})

Exemple :

{
    "success": true,
    "messages": [],
    "data": {
        "uri": "http://www.example.net/api/v1/documents/34757/usertags/my_custom",
        "userTag": {
            "id": "my_custom",
            "date": "2014-12-24 09:17:24",
            "value": {
                "my_first": 1123,
                "my_second": "Hello world"
            }
        }
    }
}

9.4.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
Document non existant	404	CRUD0200
Tag demandé inexistant	404	CRUD0223

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

Source : usertags/getUserTag.md Dynacase Platform 3.2 | API HTTP Core Manuel de référence, version 1.0 édition 3, © Anakeen Labs <labs@anakeen.com>