APIs

Les API vous permettent d'accéder aux services proposés dans le menu Gérer les packages et d'interagir avec ceux-ci. Vous pouvez utiliser ces API lorsque vous créez des automatisations codées. Rendez-vous sur la page Automatisations codées pour en savoir plus sur les automatisations codées et sur leur conception via API.

Remarque : l'utilisation de l'option Aller à Définition (Go to Definition) (F12) permet d'accéder à la définition des API UiPath pour un certain service. Nous vous recommandons de vous fier uniquement aux API directement exposées lorsque vous implémentez des automatisations codées. Les autres API qui ne sont pas directement exposées avec un service sont susceptibles d'être modifiées sans notification préalable.

Surcharges

Les API ont souvent des surcharges, ce qui signifie qu'elles fournissent plusieurs versions de la même méthode avec différentes options de paramètres. Les surcharges vous permettent de personnaliser le comportement de l'API en fonction de vos besoins. Par exemple, une API UI Automation peut avoir une surcharge qui accepte un paramètre de délai d'attente pour préciser le temps d'attente maximal d'un élément d'IU avant de terminer l'exécution.

En utilisant les API avec leurs surcharges respectives, vous pouvez facilement obtenir la logique et le comportement d'automatisation souhaités.

API de test

Remarque : les API de vérification ne prennent pas en charge la prise de captures d’écran sur les systèmes d’exploitation macOS et Linux.

API	Description
Address	Génère une adresse valide, en fonction du pays et de la ville aléatoires que vous fournissez.
AddTestDataQueueItem	Ajoute un DataRow à un TestDataQueue spécifié.
AttachDocument	Joignez des documents aux résultats d'exécution de vos tests pour avoir la preuve du résultat.
BulkAddTestDataQueueItems	Ajoutez une table de données à une file d'attente de données de test spécifiée.
DeleteTestDataQueueItems	Supprimer les éléments de la file d'attente de données de test.
GetTestDataQueueItem	Extrait un DataRow d'un TestDataQueue spécifié.
GetTestDataQueueItems	Extrait des lignes de données d'une file d'attente TestDataQueue spécifiée.
GivenName	Génère un prénom aléatoire.
LastName	Génère un nom de famille aléatoire.
RandomDate	Génère une date aléatoire entre deux dates.
RandomNumber	Génère un entier aléatoire d'une longueur donnée.
RandomString	Génère une chaîne aléatoire avec une longueur et une casse données.
RandomValue	Choisit une ligne aléatoire dans une plage de 0 à 2 milliards dans une liste à 1 colonne.
VerifyAreEqual	Vérifie si deux expressions sont égales.
VerifyAreNotEqual	Vérifie si deux expressions ne sont pas égales.
VerifyContains	Vérifie si la première expression contient la deuxième expression.
VérifierÉvaluationDocuments	Verifies if two documents are equivalent using multiple comparison options.
VerifyExpression	Vérifie la valeur de vérité d'une expression donnée.
VerifyExpressionWithOperator	Vérifie une expression en l'affirmant par rapport à une expression donnée avec un opérateur.
VerifyIsGreater	Vérifie que la première expression est supérieure à la seconde expression.
VerifyIsGreaterOrEqual	Vérifie que la première expression est supérieure ou égale à la deuxième expression.
VerifyIsLess	Vérifie que la première expression est inférieure à la seconde expression.
VerifyIsLessOrEqual	Vérifie que la première expression est inférieure ou égale à la deuxième expression.
VerifyIsRegexMatch	Vérifie si la première expression est une correspondance regex avec la seconde expression.
VerifyRange	Vérifie si une expression est située ou non dans une plage donnée.
Vérifier l'équivalent texte	Verifies if two texts are equivalent using multiple comparison options.

Utilisation des API

Utilisez le format suivant pour appeler une API à partir du service correspondant : service.API. Par exemple, system.GetAsset.