APIs

Mit APIs können Sie auf die Dienste zugreifen und mit ihnen interagieren, die im Menü Pakete verwalten angeboten werden. Sie können diese APIs verwenden, wenn Sie codierte Automatisierungen entwerfen. Unter Codierte Automatisierungen erfahren Sie mehr über codierte Automatisierungen und wie sie mit APIs gestaltet werden können.

Hinweis: Mit Zu Definition wechseln (F12) können Sie auf die Definition von UiPath-APIs für einen bestimmten Dienst zugreifen. Es wird empfohlen, sich beim Implementieren codierter Automatisierungen nur auf die direkt verfügbar gemachten APIs zu verlassen. Andere APIs, die nicht direkt mit einem Dienst verknüpft sind, können ohne vorherige Ankündigung geändert werden.

Überladungen

APIs enthalten oft Überladungen, was bedeutet, dass sie mehrere Versionen der gleichen Methode mit unterschiedlichen Parameteroptionen bereitstellen. Mit Überladungen können Sie das Verhalten der API basierend auf Ihren spezifischen Anforderungen anpassen. Beispielsweise kann eine UI-Automatisierungs-API eine Überladung enthalten, die einen Timeout-Parameter akzeptiert, um die maximale Zeit anzugeben, die gewartet werden soll, bis ein UI-Element angezeigt wird, bevor die Ausführung beendet wird.

Durch die Verwendung der APIs mit ihren jeweiligen Überladungen können Sie ganz einfach die gewünschte Automatisierungslogik und das gewünschte Verhalten erreichen.

System-APIs

API	Beschreibung
Datenzeile hinzufügen (Add Data Row)	Fügt der angegebenen DatenTabelle (DataTable) eine DatenZeile (DataRow) hinzu.
AddQueueItem	Fügt ein neues Element in einer Orchestrator-Warteschlange hinzu.
Transaktionsobjekt hinzufügen (Add Transaction Item)	Fügt ein neues Element in der Warteschlange hinzu und startet eine Transaktion.
Zeile anhängen	Fügt die angegebenen Zeichenfolge zu einer Datei hinzu und erstellt die Datei, falls sie nicht bereits vorhanden ist.
BulkAddQueueItems	Fügt eine Sammlung von Elementen aus einer angegebenen DataTable zu einer angegebenen Warteschlange in Orchestrator hinzu.
Datentabelle leeren (Clear Data Table)	Löscht alle Daten in der angegebenen Datentabelle.
ZIP-Dateien komprimieren	Fügt die angegebenen Dateien oder Ordner zu einem komprimierten (ZIP-)Dateiarchiv hinzu.
Datei kopieren	Kopiert eine Datei von einem Speicherort zu einem anderen.
Create File	Erstellt eine leere Datei am angegebenen Speicherort. Wenn an diesem Speicherort bereits eine Datei vorhanden ist,
Create Folder	Erstellt ein Verzeichnis am angegebenen Speicherort.
Delete File or Folder	Löscht eine angegebene Datei oder einen angegebenen Ordner.
Delete Queue Items	Ermöglicht Ihnen das Löschen von Elementen mit dem Status Neu aus einer angegebenen Orchestrator-Warteschlange.
Speicherdatei löschen	Löscht eine Datei von einem angegebenen Speicher-Bucket im Orchestrator.
Speicherdatei herunterladen	Lädt eine Kopie einer Datei in einem Orchestrator-Speicher-Bucket lokal herunter.
ExtractUnzipFiles	Extrahiert den gesamten Inhalt eines ZIP-Dateiarchivs in einen angegebenen Ordner.
Datentabelle filtern (Filter Data Table)	Filtert eine Datentabelle durch Angeben von Bedingungen im Filter-Widget.
Element erhalten (Get Asset)	Ruft ein angegebenes Orchestrator-Asset mithilfe eines angegebenen AssetName ab.
Anmeldedaten erhalten (Get Credential)	Ruft ein angegebenes Anmeldeinformations-Asset mithilfe eines angegebenen Asset-Namens ab.
GetJobs	Ruft eine Liste von Orchestrator-Aufträgen gemäß einem benutzerdefinierten Filter mithilfe der Orchestrator-API ab.
Get Queue Item	Die Methode ruft ein Element aus der Warteschlange ab, damit Sie es verarbeiten können (die Transaktion starten) und setzt den Status auf In Bearbeitung.
GetQueueItems	Ermöglicht Ihnen das Abrufen einer Liste von bis zu 100 Transaktionen aus einer angegebenen Orchestrator-Warteschlange gemäß mehreren Filtern, z. B. Erstellungsdatum, Priorität, Status und Referenz.
Ressource für lokalen Pfad abrufen	Erstellen Sie eine Ressource aus dem lokalen Pfad der Datei oder des Ordners.
Zeilenobjekt erhalten (Get Row Item)	Ruft einen Wert aus einer Zeile in einer Datentabelle gemäß einer angegebenen Spalte ab.
Transaktionsobjekt erhalten (Get Transaction Item)	Ruft ein Element aus der Orchestrator-Warteschlange ab, damit Sie es verarbeiten können (die Transaktion starten), und legt den Status auf InBearbeitung fest.
Prozess abrufen	Führt einen UiPath-Prozess aus, der für die lokale Maschine verfügbar ist.
Datentabellen verbinden (Join Data Tables)	Kombiniert Zeilen aus zwei Tabellen durch Verwendung von Werten, die in beiden gemeinsam vorkommen, gemäß einer Join-Regel, die im Parameter JoinType angegeben ist.
Speicherdateien auflisten	Listet Dateien auf, die mit einem bestimmten Muster aus einem angegebenen Speicher-Bucket im Orchestrator übereinstimmen.
Datentabelle nachschlagen (Lookup Data Table)	Diese Methode emuliert das Verhalten der VLOOKUP-Excel-Formel. Ermöglicht Ihnen die Suche nach einem angegebenen Wert in einer angegebenen DataTable und gibt den Zeilenindex zurück, bei dem er gefunden wurde.
Datentabelle zusammenführen (Merge Data Table)	Führt das Ziel mit der Quelle zusammen und ermöglicht die Angabe, ob Änderungen beibehalten werden und wie das fehlende Schema in der Quelle behandelt wird.
Move File	Verschiebt eine Datei von einem Speicherort zu einem anderen.
Orchestrator HTTP-Anfrage (Orchestrator HTTP Request)	Erstellt HTTP-Anfragen an die Orchestrator-API über die Authentifizierung unter dem ausführenden Roboter.
OutputDataTable	Schreibt mithilfe des CSV-Formats eine DatenTabelle (DataTable) in eine Zeichenfolge.
Pfad vorhanden (Path Exists)	Prüft, ob der angegebene Pfad existiert. Der Pfad kann ein Dateipfad oder ein Verzeichnispfad sein.
Transaktionsobjekt verschieben (Postpone Transaction Item)	Fügt Zeitparameter hinzu, zwischen denen eine Orchestrator-Transaktion verarbeitet werden muss (nicht vor dem Verschieben und nicht nach dem Fälligkeitsdatum).
Speichertext lesen	Lädt eine Datei aus einem angegebenen Speicher-Bucket im Orchestrator herunter und speichert sie in einer String-Variablen.
Textdatei lesen	Liest alle Zeichen aus einer angegebenen Datei und speichert sie in einer Variable vom Typ Zeichenfolge (String).
Datenspalte entfernen (Remove Data Column)	Entfernt eine DatenSpalte (DataColumn) aus einer angegebenen DatenTabelle (DataTable).
Doppelte Zeilen entfernen (Remove Duplicate Rows)	Entfernt doppelte Zeilen aus einer angegebenen VariableDataTable, sodass nur das erste Vorkommen beibehalten wird.
Ersetzen (Replace)	Innerhalb einer angegebenen Eingabe-Zeichenfolge werden Zeichenfolgen, die das Muster eines regulären Ausdrucks treffen, mit einer angegeben Austausch-Zeichenfolge ersetzt.
Element einstellen (Set Asset)	Ermöglicht es Ihnen, den Wert eines angegebenen Assets zu aktualisieren, das bereits im Orchestrator verfügbar ist, sei es global oder pro Roboter.
Anmeldedaten einstellen (Set Credential)	Aktualisiert den Wert eines angegebenen Assets von Anmeldeinformationen, das bereits im Orchestrator verfügbar ist, sei es global oder pro Roboter.
SetTransactionProgress	Hilft bei der Erstellung benutzerdefinierter Fortschrittsstatus für Ihre Orchestrator-Transaktionen inBearbeitung.
Transaktionsfortschritt einstellen (Set Transaction Status)	Setzt den Status eines Orchestrator-Transaktionsobjekts auf Fehlgeschlagen (Failed) oder Erfolgreich (Successful).
Datentabelle sortieren (Sort Data Table)	Sortiert eine vollständige DataTable ansteigend oder absteigend auf Grundlage der Werte einer angegebenen Spalte.
Job starten (StartJob)	Ermöglicht es Ihnen, einen Auftrag im Orchestrator für eine bestimmte Anzahl von Robotern zu starten.
Job anhalten (StopJob)	Ermöglicht Ihnen das Anhalten oder Beenden eines Auftrags in Orchestrator.
Update Row Item	Weist den angegebenen Wert der angegebenen Spalte einer Datentabellenzeile zu.
Speicherdatei hochladen	Lädt eine Datei in einen angegebenen Speicher-Bucket im Orchestrator hoch.
Warteschlangenobjekt (Wait Queue Item)	Ruft ein Orchestrator-Warteschlangenelement aus einer angegebenen Warteschlange ab und speichert es in einer QueueItem -Variablen.
Speichertext schreiben	Lädt eine Zeichenfolge in einen angegebenen Speicher-Bucket im Orchestrator hoch.
Textdatei schreiben	Schreibt den angegebenen Text in eine Datei. Wenn die Datei bereits vorhanden ist, wird der bereits vorhandene Text überschrieben.

Verwenden von APIs

Verwenden Sie das folgende Format, um eine API vom entsprechenden Dienst aufzurufen: service.API. Beispiel: system.GetAsset.