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 système

API	Description
Ajouter une ligne de données (Add Data Row)	Ajoute un DataRow à un DataTable spécifié.
AddQueueItem	Ajoute un nouvel élément dans une file d'attente Orchestrator.
Ajouter un élément de transaction (Add Transaction Item)	Ajoute un élément dans la file d'attente et démarre une transaction.
Ajouter une ligne	Ajoute la chaîne spécifiée à un fichier, en créant le fichier s'il n'existe pas déjà.
BulkAddQueueItems	Ajoute une collection d'éléments depuis un `DataTable` spécifié à une file d'attente spécifiée d'Orchestrator.
Supprimer la table de données (Clear Data Table)	Efface toutes les données de la table de données spécifiée.
CompresserFichiersZip	Ajoute les fichiers ou dossiers spécifiés à une archive de fichiers compressés (zip).
Copy File	Copie un fichier d'un emplacement spécifié à un autre.
Create File	Crée un fichier vide à l'emplacement spécifié. Si un fichier existe déjà à cet emplacement,
Créer un dossier (Create Folder)	Crée un répertoire dans l'emplacement spécifié.
Delete file or folder	Supprime un fichier ou un dossier spécifié.
Delete Queue Items	Permet de supprimer des éléments avec l'état Nouveau (New) à partir d'une file d'attente Orchestrator spécifiée.
Supprimer le fichier de stockage	Supprime un fichier d'un compartiment de stockage spécifié dans Orchestrator.
Télécharger le fichier de stockage	Télécharge localement une copie d'un fichier dans un compartiment de stockage Orchestrator.
Extraire les fichiers de décompression	Extrait tout le contenu d'une archive de fichier zip dans un dossier spécifié.
Filtrer la table de données (Filter Data Table)	Filtre un objet TableDonnées en spécifiant les conditions dans le Filtre widget .
Obtenir l'actif (Get Asset)	Obtient une ressource Orchestrator spécifiée en utilisant un NomRessource (AssetName)fourni.
Obtenir l'identifiant (Get Credential)	Obtient une ressource d'informations d'identification spécifiée à l'aide d'un nom de ressource fourni.
GetJobs	Récupère une liste d'exécutions Orchestrator en fonction d'un filtre personnalisé, à l'aide de l'API Orchestrator.
Get Queue Item	La méthode obtient un élément de la file d'attente afin que vous puissiez le traiter (démarrer la transaction) et définit son état sur En cours (In Progress).
GetQueueItems	Permet de récupérer une liste de 100 transactions maximum à partir d'une file d'attente Orchestrator indiquée, selon plusieurs filtres, tels que date de création, priorité, état et référence.
Obtenir la ressource pour le chemin d'accès local	Créez une ressource à partir du chemin local du fichier ou du dossier.
Obtenir l'élément de ligne (Get Row Item)	Récupère une valeur dans une ligne d'une table de données en fonction d'une colonne spécifiée.
Obtenir l'élément de transaction (Get Transaction Item)	Obtient un élément de la file d'attente Orchestrator afin que vous puissiez le traiter (démarrer la transaction) et définit son statut sur En cours (In Progress) .
Invoke Process	Exécute un processus UiPath disponible pour la machine locale.
Tables de données de jointure (Join Data Tables)	Combine des lignes de deux tables à l'aide de valeurs communes, selon une règle de jointure (Join) spécifiée dans le paramètre `JoinType` .
Répertorier les fichiers de stockage	Répertorie les fichiers correspondant à un modèle donné à partir d'un compartiment de stockage spécifié dans Orchestrator.
Table de données de recherche (Lookup Data Table)	Cette méthode émule le comportement de la formule Excel VLOOKUP. Il vous permet de rechercher une valeur fournie dans un `DataTable` spécifié et renvoie le RowIndex dans lequel elle a été trouvée.
Fusionner la table de données (Merge Data Table)	Fusionne la destination avec la source en indiquant s'il faut conserver les modifications et en déterminant comment résoudre le problème de schéma manquant dans la source.
Move File	Déplace un fichier d'un emplacement spécifié à un autre.
Requête HTTP Orchestrator	Envoie des requêtes HTTP à l'API Orchestrator en s'authentifiant avec le robot sur lequel il est exécuté.
OutputDataTable	Écrit un DataTable dans une chaîne en utilisant le format CSV.
Le chemin d'accès existe (Path Exists)	Vérifie si le chemin spécifié existe. Le chemin peut représenter un chemin de fichier ou un chemin de répertoire.
Différer l'élément de transaction (Postpone Transaction Item)	Ajoute des paramètres de période pendant laquelle une transaction Orchestrator doit être traitée (pas avant la date de report et pas après l'échéance).
Lire le texte de stockage	Télécharge un fichier à partir d'un compartiment de stockage spécifié dans Orchestrator et le stocke dans une variable String.
Lire le fichier texte	Lit tous les caractères d'un fichier spécifié et les stocke dans une variable String.
Supprimer la colonne de données (Remove Data Column)	Supprime un DataColumn d'un DataTable spécifié.
Supprimer les lignes dupliquées (Remove Duplicate Rows)	Supprime les lignes en double d'une variable `DataTable` spécifiée, en ne conservant que la première occurrence.
Remplacer (Replace)	Dans une chaîne d'entrée spécifiée, remplace les chaînes qui correspondent à un modèle d'expression régulière par une chaîne de remplacement spécifiée.
Définir l'actif (Set Asset)	Permet de mettre à jour la valeur d'une ressource indiquée, qui est déjà disponible dans Orchestrator, que ce soit une ressource globale ou Par robot.
Définir l'identifiant (Set Credential)	Met à jour la valeur d'une ressource identifiant indiquée déjà disponible dans Orchestrator, que ce soit une ressource globale ou Par robot.
SetTransactionProgress	Permet de créer des statuts de progressionpersonnalisés pour vos transactions Orchestrator en cours.
Définir l'état de transaction (Set Transaction Status)	Définit le statut d'un élément de transaction Orchestrator sur Échec (Failed) ou Réussi (Successful).
Trier la table de données (Sort Data Table)	Trie une `DataTable` complète par ordre croissant ou décroissant, selon les valeurs d'une colonne spécifiée.
Démarrer la tâche (StartJob)	Démarre une exécution dans Orchestrator pour un nombre spécifié de Robots.
Arrêter la tâche (StopJob)	Permet d'arrêter ou d'arrêter une tâche sur Orchestrator.
Update Row Item	Assigne la valeur spécifiée à la colonne indiquée d’une ligne TableDonnées.
Télécharger le fichier de stockage	Charge un fichier dans un compartiment de stockage spécifié dans Orchestrator.
Wait Queue Item	Récupère un élément de file d'attente Orchestrator à partir d'une file d'attente spécifiée et le stocke dans une variable `QueueItem` .
Écrire le texte de stockage	Charge un fichier dans un compartiment de stockage spécifié dans Orchestrator.
Écrire un fichier texte	Écrit le texte spécifié dans un fichier. Si le fichier existe déjà, le texte préexistant est écrasé.