Points de terminaison d'API REST pour Workflows

GetWorkflowWorkflows

Mise à jour d'un workflow. La mise à jour d'un workflow peut concerner son champ observations. Il est possible de modifier son état ce qui peut déclencher des actions. La modification de l'état peut être antidatée en précisant une date de fin (par défaut la date du jour).

Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.

Paramètres du corps de la requête

date_de_fin string

Date de fin de traitement du workflow (date à laquelle il est passé en terminé).

format : date-time 20 min length 50 max length

etat string

État du workflow.

Valeurs possibles
`VALIDE` Le workflow est traité, vérouillé et peut débloquer d'autres workflows liés.
`EN_COURS` Le workflow devient actif pour traitement.
`ATTENTE` Le workflow est en attente de la complétion d'autres workflows.
`PAUSE` Le workflow est en pause et ne peut être traité.
`NON_CONCERNE` Le workflow n'est pas concerné par le dossier en cours de traitement.
`ATTENTE_VALIDATION` Le workflow est en attente de validation par un utilisateur.

observations string

Une chaîne de caractères arbitraire rattachée à l'objet. Souvent utile pour affichage aux utilisateurs.

8192 max length

Réponses

200 OK

Retourne un Objet Workflow contenant les données demandées.

POST /workflows/{workflow_id}

Schéma de la réponse

id string required

Identifiant unique de l'objet.

format : uuid 36 fixed length

titre string required

Titre du workflow.

256 max length

date_de_creation string required

Date de création du workflow.

format : date-time 20 min length 50 max length

date_de_debut string required nullable

Date du déclenchement du workflow (date à laquelle il est passé actif).

format : date-time 20 min length 50 max length

date_de_fin string required nullable

Date de fin de traitement du workflow (date à laquelle il est passé en terminé).

format : date-time 20 min length 50 max length

workflow_automatise boolean required

Si le workflow a été géré par un processus automatisé.

etat string required

État du workflow.

Valeurs possibles
`VALIDE` Le workflow est traité, vérouillé et peut débloquer d'autres workflows liés.
`EN_COURS` Le workflow devient actif pour traitement.
`ATTENTE` Le workflow est en attente de la complétion d'autres workflows.
`PAUSE` Le workflow est en pause et ne peut être traité.
`NON_CONCERNE` Le workflow n'est pas concerné par le dossier en cours de traitement.
`ATTENTE_VALIDATION` Le workflow est en attente de validation par un utilisateur.

observations string required nullable

Une chaîne de caractères arbitraire rattachée à l'objet. Souvent utile pour affichage aux utilisateurs.

8192 max length

type string required

Type du workflow.

Valeurs possibles
`analyse_de_risque` Analyse de risque.
`validation` Validation.
`arrivee_sis` Arrivée SIS.
`arrivee_sis_prev` Arrivée SIS préventive.
`arrivee_secretariat_commission` Arrivée au secrétariat de la commission.
`consultation_sis` Consultation SIS.
`passage_commission` Passage en commission.
`relecture` Relecture.
`visite` Visite.
`arrivee_secretariat` Arrivée au secrétariat.
`workflow` Workflow générique.
`reception_de_travaux_en_attente` Réception de travaux en attente.

Points de terminaison d'API REST pour Workflows

Détails d'un workflow

Réponses

Mise à jour d'un workflow

Paramètres du corps de la requête

Réponses