Deserialize JSON

UiPath.WebAPI.Activities.DeserializeJson

Description

Désérialise la chaîne ou l’exemple JSON en objet JSON. Par défaut, le résultat est JObject, mais vous pouvez choisir un type de sortie différent à l'aide de la propriété Type de sortie .

Compatibilité du projet

Windows - Héritage | Windows | Multiplate-forme

Prérequis

Pour configurer la propriété Paramètres du sérialisateur à l'aide du mappage des données, utilisez Studio 25.10 ou une version ultérieure. Dans les versions antérieures de Studio, cette propriété utilise à la place la fenêtre de l’Éditeur d’expressions .

Windows, configuration multiplate-forme

• JSON String - The string containing the JSON to be deserialized. The JSON should be written without indents, and between double quotes. Strings inside the JSON should be written with single quotes. For example, the following JSON is valid: "{'TenancyName': 'Documentation', 'UsernameOrEmail': 'Documentation', 'Password': 'Documentation'}".
• Exemple de JSON : exemple du fichier JSON utilisé pour générer les propriétés de l'objet de sortie. L’exemple doit être au format JSON. L’activité convertit cet exemple en un objet similaire que vous pouvez utiliser au moment de la conception.

Options avancées

Entrée

• Paramètres de sérialisation : les paramètres de désérialisation personnalisés à utiliser lors de la désérialisation de la chaîne JSON. Utilisez cette propriété lorsque vous souhaitez contrôler entièrement la façon dont la chaîne JSON est désérialisée.
• Type de sortie : une liste déroulante qui vous permet de choisir le type d'argument de l'objet dans lequel désérialiser.
  Remarque :

  Dans Studio Web, la génération de la structure de sortie à partir de l' exemple JSON rend la propriété Type de sortie en lecture seule.

Sortie

• ObjetJSON : Le désérialisé JSON est renvoyé en tant qu'objet du type sélectionné dans la propriété Type de sortie . Lorsque le type par défaut est utilisé, il en résulte une variable Newtonsoft.Json.Linq.JObject . En savoir plus sur les objetsNewtonsoft.Json.Linq.JObject .

Exemple d'utilisation de l'exemple JSON

La propriété Exemple de JSON génère la structure de l'objet de sortie au moment de la conception à partir d'un extrait JSON représentatif. Après avoir fourni un exemple, l'activité infère un type correspondant et l'affecte à la propriété Type de sortie afin que vous puissiez référencer les valeurs désérialisées par nom dans les activités en aval au lieu de les interroger avec SelectToken

Remarque :

La propriété Exemple JSON est un assistant de conception. Elle est disponible dans Studio Web et dans les versions de Studio qui prennent en charge l'inférence de type personnalisé. Lorsque ces fonctionnalités ne sont pas disponibles, la propriété est masquée.

Pour illustrer comment utiliser l' exemple JSON, nous extrayons le nom et la ville d'une personne à partir d'une chaîne JSON:

1. Ajoutez une activité Désérialiser JSON à votre workflow.

2. Dans le champ Chaîne JSON , saisissez le JSON à désérialiser. Par exemple: "{'name': 'John Doe', 'age': 30, 'address': {'city': 'New York'}}".

3. Dans le champ Échantillon JSON , collez un échantillon représentatif avec la même structure:

   {
     "name": "John Doe",
     "age": 30,
     "address": {
       "city": "New York"
     }
   }
   

   L'activité lit l'exemple et génère un objet de sortie qui reflète cette structure. La propriété Type de sortie est mise à jour avec le type généré.

4. Dans une activité ultérieure, référencez les valeurs désérialisées directement via les noms de propriété définis dans votre exemple, par exemple JsonObject.name et JsonObject.address.city, au lieu d'utiliser JsonObject.SelectToken("name").

Résultat

L'objet de sortie expose les propriétés de votre exemple. Ainsi, JsonObject.name renvoie John Doe et JsonObject.address.city renvoie New York sans interroger le JSON avec SelectToken

Exemple d'utilisation des paramètres du sérialisateur

Lorsqu’aucun mappage de données n’est disponible pour la propriété Paramètres du sérialisateur , configurez-le dans l’ éditeur d’expressions à l’aide de l’un des extraits de code suivants. Pour plus d'informations, consultez la documentation Newtonsoft.

VB.NET

New JsonDeserializationSettings With {
.MissingMemberHandling = JsonMissingMemberHandling.Ignore,
.NullValueHandling = JsonNullValueHandling.Ignore,
.DateParseHandling = JsonDateParseHandling.DateTime,
.DateTimeZoneHandling = JsonDateTimeZoneHandling.Utc,
.FloatParseHandling = JsonFloatParseHandling.Double
}

C#

new JsonDeserializationSettings
{
MissingMemberHandling = JsonMissingMemberHandling.Ignore,
NullValueHandling = JsonNullValueHandling.Ignore,
DateParseHandling = JsonDateParseHandling.DateTime,
DateTimeZoneHandling = JsonDateTimeZoneHandling.Utc,
FloatParseHandling = JsonFloatParseHandling.Double
}

Configuration Windows - Héritage

Panneau propriétés

Commun

• NomAffichage (DisplayName) - Nom affiché de l'activité.

Entrée

• Exemple JSON : exemple JSON pour la structure de sortie. L’activité convertit cet exemple en un objet similaire que vous pouvez utiliser au moment de la conception.
• Chaîne Json - Chaîne contenant le fichier JSON à désérialiser. Écrivez le JSON sans retrait et entre guillemets. Les chaînes à l'intérieur du fichier JSON doivent être écrites avec des apostrophes. Par exemple, le fichier JSON suivant est valide : « {’TenancyName » : ’Documentation’, ’UsernameOrEmail’ : ’Documentation’, ’Password’ : ’Documentation’} ».

Divers

• Privé (Private) - Si cette option est sélectionnée, les valeurs des variables et des arguments ne sont plus enregistrées au niveau Détaillé (Verbose).
• TypeArgument : une liste déroulante qui permet de sélectionner le type de sortie renvoyé. La chaîne JSON fournie sera convertie en un objet du type sélectionné.

Sortie

• ObjetJSON : Le désérialisé JSON comme variable Newtonsoft.Json.Linq.JObject En savoir plus sur les objetsNewtonsoft.Json.Linq.JObject .

Exemple d’utilisation de l’activité Deserialize Json

L'activité Désérialiser Json est utilisée pour extraire des données des fichiers et des chaînes JSON.

Pour illustrer comment utiliser cette activité, nous avons créé un exemple qui effectue l'activité Désérialiser Json pour extraire l'âge d'une personne depuis un fichier JSON.

Voici comment le processus d'automatisation peut être créé :

1. Ouvrez Studio et démarrez un nouveau Processus.
2. Drag a Sequence to the Workflow Designer.

   • Créez les variables suivantes :

     Nom de variable	Types de variables	Valeur par défaut
     JsonText	Chaîne de caractères (string)
     JsonObj	ObjetJ
     Age	ValeurGénérique

3. Drag a Read Text File activity inside the sequence container.
   • In the Properties panel, add the value "JsonString.txt" in the FileName field.
   • Add the variable JsonText in the Content field.
4. Ajoutez une activité Désérialiser JSON (Deserialize JSON) sous l’activité Lire le fichier texte (Read Text File).
   • In the Properties panel, add the variable JsonText in the JsonString field and the variable JsonObj in the JsonObject field.
   • Select the value Newtonsoft.Json.Linq.JObject from the TypeArgument drop-down list.
5. Place an Assign activity under the Deserialize JSON activity.
   • Add the variable Age in the To field and the expression JsonObj.SelectToken("age").ToString in the Value field.
6. Faites glisser une activité Écrire une ligne (Write Line) sous l’activité Affecter (Assign).
   • Ajoutez la variable Age dans le champ Texte.
7. Run the process. The robot extracts the age value from the .json file and displays it in the Output panel.

Ici, vous pouvez télécharger un exemple.