7.3 Récupérer les caractéristiques d'un état

7.3.1 URL

GET /api/v1/documents/<documentId>/workflows/states/<stateId>

Récupération de l'état stateId du document documentId.

Exemple :

GET /api/v1/documents/my_document/workflows/states/my_published

7.3.2 Content

Le contenu de la requête est vide.

7.3.3 Structure de retour

Le retour est une donnée JSON.

7.3.3.1 En cas de réussite :

La partie data contient :

1. uri : URI préférentielle d'accès à la ressource;
2. state : Caractéristique de l'étape
   1. id : identifiant de l'état,
   2. isCurrentState : indique si cet état est l'étape courante,
   3. label : intitulé de l'état (localisé en fonction de la langue de l'utilisateur)
   4. activity : intitulé de l'activité (localisé en fonction de la langue de l'utilisateur)
   5. displayValue : intitulé calculé en fonction des valeurs de "activity" et "label"
   6. color : code couleur (#RRGGBB) associé à l'état
   7. transition : transition qui emmène à cet étape ("null" si pas de transition possible)
      1. uri : uri de la transition
      2. label : libellé de la transition

Exemple :

{
    "success": true,
    "messages": [],
    "data": {
        "uri": "./api/v1/documents/61120/workflows/states/my_transmited",
        "state": {
            "id": "my_transmited",
            "isCurrentState": false,
            "label": "Transmis",
            "activity": "Vérification de l'adoption",
            "displayValue": "Vérification de l'adoption",
            "color": "#A8E5FF",
            "transition": {
                "uri": "./api/v1/documents/61120/workflows/transitions/my_Ttransmited",
                "label": "Transmettre le dossier"
            }
        }
    }
}

7.3.3.2 En cas d'échec

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

Exemple :

 {
    "success": false,
    "messages": [
        {
            "type": "error",
            "contentText": "State \"foo\" is not available for  workflow \"My workflow\" (1090)",
            "code": "CRUD0228"
        }
    ],
    "data": null,
    "exceptionMessage": "State \"foo\" is not available for  workflow \"My workflow\" (1090)"
}