8.4 Consultation d'un document supprimé

8.4.1 URL

Récupération d'un document du trash.

GET /api/v1/trash/<documentId>

Récupération de la dernière révision du document supprimé ayant pour id <documentId>.

L'extension ".json" peut être ajoutée pour expliciter le format de sortie.

Exemple :

GET /api/v1/trash/1234.json

L'identifiant du document peut être son nom logique, son identifiant numérique.

8.4.2 Content

Le contenu de la requête est vide.

8.4.3 Structure de retour

Le retour est une donnée JSON.

8.4.3.1 En cas de réussite :

La partie data contient 3 champs :

document.uri : uri d'accès à la ressource modifiée
document.properties : liste des valeurs des propriétés
document.attributes : liste des valeurs des attributs

Les attributs en visibilité "I" ne sont pas retournés.

Exemple :

{"success" :             true,
    "messages" :         [],
    "data" :             {
        "document" : {
            "uri" :        "api\/v1\/documents\/1057.json",
            "properties" : {
                "title" :     "Aristote le Stagirite",
                "name" :      null,
                "icon" :      "api/v1/images/assets/sizes/24x24c/doc.png"
                [...]
            },
            "attributes" : {
                "my_title" :            {"value" : "[123", "displayValue" : "[123"},
                "my_level" :          {"value" : 34, "displayValue" : "34"}
                [...]
            }
        }
    }
}

8.4.3.2 En cas d'échec

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

Raison	Status HTTP	Error Code
Document non trouvé	404	API0200
Privilège insuffisant pour accéder au document	403	API0201
Document supprimé	404	API0219
Propriété demandée inexistante	400	API0202
Attribut demandé inexistant	400	API0218

Exemple :

Cas d'erreur de document non trouvé

{"success" :             false,
    "messages" :         [
        {
            "type" :        "error",
            "contentText" : "Document \"1200\" not found",
            "contentHtml" : "",
            "code" :        "API0200",
            "uri" :         "",
            "data" :        null
        }
    ],
    "data" :             null,
    "exceptionMessage" : "Document \"1200\" not found"
}

8.4.4 Résultat partiel

Le document peut être retourné avec plus ou moins d'information.

GET /api/v1/trash/1234.json?fields=document.properties
GET /api/v1/trash/1234.json?fields=document.properties.id,document.properties.title,document.attributes
GET /api/v1/trash/1234.json?fields=document.properties.id,document.properties.title,document.attributes.my_exemple
GET /api/v1/trash/1234.json?fields=document.properties.id,document.properties.title,document.attributes,family.structure

Par défaut : fields=document.properties,document.attributes

fields	Signification	Remarques
`document.properties`	Récupère les propriétés données par défaut	"id", "title", "icon", "initid", "name", "revision"
`document.properties.<prop>`	Récupère la propriété indiquée
`document.attributes`	Récupère les valeurs et les valeurs affichable des attributs
`document.attributes.<id>`	Récupère la valeur d'un attribut particulier
`document.family.structure`	Récupère la structure de la famille

La liste des propriétés est documentée dans la documentation de format collection.

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