Orkyvo (API de la plateforme)
Lit les workflows, les exécutions et le journal d'audit de l'organisation, ou annule une exécution.
Fonctionnement
Agit dans l'organisation de l'exécution seulement, avec les droits de la personne responsable de l'exécution (celle qui l'a lancée, sinon celle qui a activé le workflow). Aucune clé d'API n'est nécessaire et aucun secret n'est renvoyé.
Paramètres
| Paramètre | Type | Détail |
|---|---|---|
| Opération | choix | Valeurs : Workflows : lister, Workflow : détails, Exécutions : lister, Exécution : détails et étapes, Exécution : annuler, Journal d'audit : derniers événements. |
| Workflowobligatoire · selon les autres paramètres | workflow | — |
| Workflow (facultatif)selon les autres paramètres | workflow | — |
| Identifiant d'exécutionobligatoire · selon les autres paramètres | texte | — |
| Statutsselon les autres paramètres | choix multiple | Valeurs : QUEUED, RUNNING, WAITING, SUCCEEDED, FAILED, CANCELED, TIMED_OUT. |
| Donnée d'exécution (clé=valeur)selon les autres paramètres | texte | — |
| Nombre maximalselon les autres paramètres | nombre | 100 au plus. |
Données reçues et renvoyées
- EntréeListe d'éléments : une opération par élément.
- SortieLister : un élément par workflow, exécution ou événement. Détails : un élément. Annuler : { executionId, canceled }.
Erreurs
Droits insuffisants (lecture des workflows, exécution, audit), workflow ou exécution d'une autre organisation ou introuvable, clé de donnée invalide.
À savoir. Activer ou désactiver un workflow reste une action de l'interface ou de l'API : elle passe par les contrôles d'offre et les enregistrements chez les fournisseurs, que ce bloc ne contourne pas.
Exemple
Paramètres d'un bloc prêt à l'emploi. Dans l'éditeur, l'onglet Aide du bloc applique cet exemple en un clic.
{
"operation": "execution.list",
"status": [
"FAILED"
],
"limit": "20"
}