Accès API à Concepteur de flux

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 2 minutes de lecture

    • Les développeurs d’applications peuvent accéder aux Concepteur de flux fonctionnalités via des API pour les flux, les flux secondaires et les actions. Les concepteurs de flux peuvent activer des flux, des flux secondaires et des actions individuels pouvant être appelés par le client pendant la conception.

    API disponibles Concepteur de flux

    Déclenchez des flux, des flux secondaires et des actions à l’aide de ces API à partir de scripts serveur ou clients.

    Côté serveur
    FlowAPI : déclenchez un flux, un flux secondaire ou une action à l’aide de méthodes synchrones ou asynchrones, avec ou sans détails d’exécution.
    Côté client
    GlideFlow : effectuez des interactions côté client avec des actions, des flux et des flux secondaires. Les concepteurs de flux doivent activer l’appel d’un flux, d’un flux secondaire et d’une action à partir du client.

    Méthodes rapides FlowAPI

    Utilisez des méthodes rapides dans la classe FlowAPI pour exécuter une action, un flux ou un flux secondaire à partir d’un script côté serveur sans créer de détails d’exécution ou d’autres enregistrements connexes. Utilisez ces méthodes pour augmenter la vitesse de traitement des gros volumes dans un environnement de production et pour améliorer les performances en éliminant les frais généraux liés à la tenue des dossiers. Les méthodes utilisées sont les suivantes :

    • executeActionQuick(), executeFlowQuick(), executeSubflowQuick() : exécutez une action, un flux ou un flux secondaire à partir d’un script côté serveur de manière synchrone à partir de la session utilisateur actuelle.
    • startActionQuick(), startFlowQuick(), startSubflowQuick() : exécutez une action, un flux ou un flux secondaire à partir d’un script côté serveur de manière asynchrone.

    API de diffusion en continu XML et JSON

    Créez une charge utile JSON ou XML volumineuse en streaming ou non à utiliser dans une demande REST ou SOAP pour envoyer des données en bloc à une API tierce. Par exemple, vous pouvez utiliser ces API pour créer une charge utile JSON dans l’étape ServiceNow® Concepteur de flux Script et transmettre la valeur renvoyée à l’étape REST pour envoyer la demande à un service tiers. Pour en savoir plus, reportez-vous aux sections JSONStreamingBuilder et XMLStreamingBuilder .

    API clientes pouvant être appelées

    Par défaut, les flux, les flux secondaires et les actions ne peuvent être appelés que par l’API FlowAPI dans un script serveur. Les concepteurs de flux et d’actions peuvent mettre des flux, des flux secondaires ou des actions individuels à la disposition des appels du client en activant l’option Client joignable pendant le processus de conception.

    Exécuter en tant que support

    Les flux et les flux secondaires peuvent s’exécuter en tant qu’utilisateur système ou en tant qu’utilisateur qui initie la session. Définissez ce comportement à partir des propriétés du flux. Toutes les méthodes rapides d’API ignorent la propriété Exécuter en tant que et s’exécutent toujours en tant qu’utilisateur système.

    Les actions s’exécutent toujours en tant qu’utilisateur qui initie la session.

    Extraits de code

    Les développeurs d’applications peuvent générer une fonction JavaScript qui appelle un flux, un flux secondaire ou une action spécifique avec l’option Extrait de code . Utilisez l’extrait de code dans des scripts tels que des règles métier ou le module Scripts - Backgound pour appeler des éléments spécifiques Concepteur de flux . Le système génère uniquement des extraits de code pour les flux, les flux secondaires et les actions publiés. Concepteur de flux Les éléments à l’état Brouillon ou Modifié ne génèrent pas d’extraits de code.