Mettre en place un scénario pour déclenchement par API

Pour qu'un scénario puisse être déclenché via webservice, il doit être paramétré dans ce sens lors de sa création.

Parmi les blocs "Événements de départ" disponibles, il convient de choisir le bloc de type "Démarrer". Il s'agit du seul événement de départ qui permettra le déclenchement du scénario par API. Après son activation, un scénario n'est plus modifiable. Il est donc nécessaire de décider s'il devra être déclenché par API dès la conception du scénario.

Obtenir les informations des scénarios existants pour une table de profils

Lors du déclenchement d'un scénario par API, il est nécessaire de se référer au nom technique du scénario visé.

Ce nom technique ne correspond pas au nom d'affichage que vous avez pu donner au scénario à sa conception. De plus, il n'est pas facilement accessible via l'interface ACTITO.

Pour obtenir le nom technique d'un scénario, il est possible d'utiliser l'opération GET/entity/{e}/table{t}/scenario

Cette méthode vous permettra d'obtenir la liste des tous les scénarios liés à une base de données spécifique.

Les paramètres à renseigner sont :

• l'entité à laquelle la table de profils appartient

• le nom de la table de profils visée par le scénario

• un filtre sur le nom d'affichage pour viser un scénario particulier. Vous pouvez insérer des astérisques avant et après le terme de recherche pour effectuer une recherche partielle

• un filtre permettant d'obtenir uniquement les scénarios déclenchés par webservices (isStartEventTriggered=true)

• un filtre permettant d'obtenir uniquement les scénarios actifs (isActive=true)

Exemple de requête et de réponse : (Téléchargez cet exemple)

La réponse vous donnera les deux identifiants qui permettent de déclencher un scénario via appel webservice :

• "name" : il s'agit du nom technique du scénario, basé sur son nom d'affichage suivi d'une séquence de caractères

• "id" : il s'agit de l'identifiant technique auto-généré

Déclencher un scénario via API

Lorsqu'un profil répond à la condition de déclenchement du scénario telle qu'elle est définie dans votre système interne, vous avez la possibilité de programmer un appel webservice qui déclenche le scénario ACTITO pour ce profil.

Pour ce faire, il convient d'utiliser l'opération POST/entity/{e}/table/{t}/scenario/{s}/profile/{p}

Les paramètres à renseigner sont :

• l'entité à laquelle la table de profils appartient

• le nom de la table de profils visée par le scénario

• l'identifiant du scénario : vous pouvez utiliser de façon interchangeable le nom technique du scénario et son identifiant auto-généré, tels que vous les avez obtenus grâce à la méthode GET expliquée ci-dessus

• l'identifiant du profil : il peut s'agit de son identifiant technique ("profileId") ou d'une paire "attributClé=valeur"

Exemple de requête et de réponse : (Téléchargez cet exemple)

La réponse obtenue sera la clé business de l'interaction ainsi créée.