7.8 Récupérer la liste des transitions

7.8.1 URL

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

Récupération de toutes les transitions du document documentId.

Exemple :

GET /api/v1/documents/61120/workflows/transitions/

7.8.2 Content

Le contenu de la requête est vide.

7.8.3 Structure de retour

Le retour est une donnée JSON.

7.8.3.1 En cas de réussite :

La partie data contient :

uri : URI préférentielle d'accès à la ressource;
transitions : Liste de transition
1. uri : identifiant de l'état de départ
2. label : libellé de la transition (localisé en fonction de la langue de l'utilisateur)
3. valid : indique si la transition existe depuis l'étape courante
  Cela ne vérifie pas si l'utilisateur courant peut passer la transition

Exemple :

{
    "success": true,
    "messages": [],
    "data": {
        "uri": "./api/v1/documents/61120/workflows/transitions/",
        "transitions": [
            {
                "uri": "./api/v1/documents/61120/workflows/transitions/my_Ttransmited",
                "label": "Transmettre le dossier",
                "valid": true
            },
            {
                "uri": "./api/v1/documents/61120/workflows/transitions/my_Taccepted",
                "label": "Accepter le dossier",
                "valid": false
            },
            {
                "uri": "./api/v1/documents/61120/workflows/transitions/my_Trefused",
                "label": "Refuser le dossier",
                "valid": false
            },
            {
                "uri": "./api/v1/documents/61120/workflows/transitions/my_Trealised",
                "label": "Fin de traitement",
                "valid": false
            },
            {
                "uri": "./api/v1/documents/61120/workflows/transitions/my_Tretry",
                "label": "À corriger",
                "valid": false
            }
        ]
    }
}

7.8.3.2 En cas d'échec

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

Raison	Status HTTP	Error Code
Pas de cycle de vie associé	404 No workflow detected	CRUD0227

Exemple :

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

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