12.3 Propriétés d'une famille

12.3.1 URL

GET /api/v1/families/<famName>

Récupération de la ressource décrivant la famille <famName>.

Exemple :

GET /api/v1/families/my_cookbook

Le nom de la famille est insensible à la casse.

12.3.2 Content

Le contenu de la requête est vide.

12.3.3 Structure de retour

Le retour est une donnée JSON.

12.3.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. document.properties : liste des valeurs des propriétés;

Exemple :

{
    "success": true,
    "messages": [],
    "data": {
        "document": {
            "properties": {
                "id": 1065,
                "title": "Articles",
                "icon": "api/v1/images/assets/sizes/24x24c/article.png",
                "initid": 1065,
                "name": "MY_ARTICLE",
                "revision": 0
            },
            "uri": "http://localhost/tmp32/api/v1/families/MY_ARTICLE.json"
        }
    }
}

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

12.3.4 Résultat partiel

La ressource peut être retournée avec plus ou moins d'information.

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

Par défaut : fields=document.properties

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