7.5 Récupérer la liste des étapes

7.5.1 URL

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

Récupération des étapes suivantes possibles du document documentId.

Les étapes possibles sont les étapes qui ont une transition pour rejoindre l'étape suivante et dont l'utilisateur a les privilège pour passer la transition.

Si la méthode m0 d'une transition, retourne un message, l'étape suivante sera retournée en indiquant l'erreur.

Le paramètre optionnel allStates=1 permet de retourner toutes les étapes même celles qui n'ont pas de transition.

Exemple :

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

7.5.2 Content

Le contenu de la requête est vide.

7.5.3 Structure de retour

Le retour est une donnée JSON.

7.5.3.1 En cas de réussite :

La partie data contient :

1. uri : URI préférentielle d'accès à la ressource;
2. states : Liste des états
   1. id : identifiant de l'état,
   2. label : intitulé de l'état (localisé en fonction de la langue de l'utilisateur)
   3. activity : intitulé de l'activité (localisé en fonction de la langue de l'utilisateur)
   4. displayValue : intitulé calculé en fonction des valeurs de "activity" et "label"
   5. color : code couleur (#RRGGBB) associé à l'état
   6. uri : URI d'accès à l'état
   7. transition : transition qui emmène à cet étape ("null" si pas de transition possible)
      1. id : identifiant de la transition 1.0.1
      2. uri : uri de la transition
      3. label : libellé de la transition
      4. error : message de la méthode m0
      5. authorized : indique si l'utilisateur possède le droit d'effectuer la transition 1.0.1

Exemple :

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

7.5.3.2 En cas d'échec

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

Exemple :

{
    "success": false,
    "messages": [
        {
            "type": "error",
            "contentText": "No associated workflow for document \"9567\"",
            "code": "CRUD0227"
        }
    ],
    "data": null,
    "exceptionMessage": "No associated workflow for document \"9567\""
}