Étape du générateur JSON

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 4 minutes de lecture

    • Créez une charge utile JSON à utiliser dans une autre étape. Saisissez des valeurs ou utilisez des pastilles de données pour produire une charge utile dynamique. Cette étape prend en charge plusieurs types de données, y compris les objets et les tableaux pour les structures imbriquées.

    Rôles et disponibilité

    Cette étape nécessite un abonnement Hub d'intégration. Pour plus d’informations, consultez Calendriers juridiques - Vue d’ensemble du concentrateur d’intégration. Une fois le module d’extension requis activé, l’étape est visible sous Intégrations.

    Disponible en tant qu’étape d’action Studio de workflow . Les utilisateurs disposant du rôle action_designer peuvent créer une action personnalisée avec une ou plusieurs étapes d’action.

    Entrées

    Renseignez chaque entrée nécessaire pour votre action. Pour ajouter des valeurs dynamiques, vous pouvez également glisser-déplacer les pilules du panneau de données ou les sélectionner dans le sélecteur de pilules.

    Nom
    Type de données : String

    Partie nom d’une paire nom-valeur. Entrez une valeur ou utilisez une pastille de données pour produire une charge utile dynamique.

    Valeur
    Type de données : String

    Partie valeur d’une paire nom-valeur. Entrez une valeur ou utilisez une pastille de données pour produire une charge utile dynamique. Vous pouvez utiliser une pastille d’objet complexe pour remplir une ligne avec un type de données d’objet, mais cela supprime tous les enfants que la pastille d’objet complexe possède déjà.

    Type
    Type de données : Choice
    Type de données pour la paire nom-valeur. Si vous utilisez une pastille de données pour le nom ou la valeur, assurez-vous que le type de données de la pastille correspond au type de données sélectionné ici. Les options sont les suivantes :
    • Chaîne
    • Objet
    • Numéro
    • Booléen
    • Tableau

    Pour les tableaux et les objets, utilisez l’icône plus ( icône plus) pour ajouter des paires nom-valeur au tableau ou à l’objet.

    En cas de valeur vide
    Type de données : Choice
    Option permettant de spécifier ce qu’il faut faire si une paire nom-valeur a une valeur vide ou nulle.
    • Laisser tel quel : conserve la valeur vide ou null comme une chaîne vide.
    • Omettre la propriété : exclut une paire nom-valeur si la valeur est vide ou nulle.
    • Définir comme nul : renvoie une valeur vide ou null comme type de données null.
    • Générer une erreur : renvoie une erreur si une paire nom-valeur a une valeur vide ou nulle.
    Inclure la structure extérieure
    Type de données : True/False

    Option permettant d’inclure les accolades pour un conteneur JSON de niveau supérieur.

    Omettre la structure vide
    Type de données : True/False

    Option permettant d’omettre une charge utile vide. Des charges utiles vides peuvent se produire lorsque vous sélectionnez Omettre la propriété pour l’entrée En cas de valeur vide pour chaque paire nom-valeur et toutes les paires nom-valeur de la charge utile produisent des valeurs vides.

    Structure
    Type de données : Structure

    Charge utile en lecture seule produite par l’étape.

    En cas d'échec de cette étape
    Type de données : Choice

    Option permettant de continuer à exécuter l’étape suivante ou d’accéder à l’évaluation des erreurs. Pour utiliser le code d’état ou le message de l’étape pour une condition d’erreur d’action personnalisée, reportez-vous à la section Évaluation de l’erreur d’action.

    Sorties

    Ces résultats apparaissent dans le panneau de données. Vous pouvez les utiliser comme entrées ailleurs dans votre action.

    Sortie
    Type de données : String

    Charge utile JSON sous forme de chaîne. Si vous souhaitez utiliser la charge utile en tant qu’objet, vous pouvez utiliser l’étape de l’analyseur JSON pour analyser la chaîne.

    État de l'étape
    Type de données : Object

    Pastille de données d’objet contenant des détails d’exécution sur l’étape. Chaque étape d’une action renvoie un état d’étape.

    Code > d’état de l’étape
    Type de données : Integer

    Pastille de données entière indiquant si l’étape a produit une erreur. Par défaut, une valeur de 1 indique que l’étape a produit une erreur. La valeur 0 indique que l’étape s’est exécutée avec succès. Vous ne pouvez pas personnaliser ces codes.

    Message >état de l’étape
    Type de données : String

    Pilule de données de chaîne contenant le message d’erreur produit par l’opération de l’étape ou du système. Vous ne pouvez pas personnaliser ce message.

    Générer une charge utile JSON

    Générez automatiquement une charge utile JSON avec le bouton Ajouter JSON pour la charge utile . Ce bouton ouvre l’éditeur de script Ajouter une charge utile dans lequel vous pouvez entrer une charge utile JSON à désérialiser automatiquement en entrée structurée.

    Il y a quelques détails à prendre en compte lors de l’utilisation du générateur de charge utile JSON.
    • Si le JSON a des clés vides, la charge utile est toujours générée.
    • S’il existe des clés en double dans l’éditeur de script, la dernière entrée de clé de l’objet remplace la valeur des clés précédentes portant le même nom.
    • Si l’objet racine est un tableau, le tableau racine est encapsulé dans un objet racine.
    • Si un tableau contient plusieurs objets, toutes les clés des objets sont fusionnées en un seul objet parent.
    Le générateur de charge utile JSON ne prend pas en charge les éléments suivants.
    • Charges utiles vides
    • Types d’objets non complexes
    • JSON non valide
    • des objets racines vides, tels qu’un tableau vide
    • charges utiles supérieures à 65 000 octets
    Remarque :
    La génération d’une charge utile JSON remplace toutes les structures existantes dans l’étape du générateur JSON.