UiPath Documentation
uipath-cli
latest
false
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UiPath-CLI-Benutzerhandbuch

UIP-Ressource

uip resource verwaltet die Orchestrator-Ressourcen, von denen Automatisierungen zur Laufzeit abhängen – Assets, Buckets und Bucket-Dateien, Bibliotheken, Warteschlangen und Warteschlangenelemente, Trigger und Webhooks. Es ist die allgemeine CRUD-Oberfläche über diese Entitäten, getrennt von uip solution resource (die lokale Lösungsressourcendeklarationen überprüft) und von uip or (dem Orchestrator-Automatisierungstool für Aufträge, Prozesse, Ordner usw.).

Hinweis:

Der Tool-Alias ist resource (Singular), nicht resources. Jedes Beispiel verwendet uip resource <kind>.

uip resource wird vom Plugin @uipath/resource-tool bereitgestellt. Wenn sie noch nicht installiert ist, wird uip tools install resource hinzugefügt. Siehe Tools (Plugins).

Ressourcen

Jede Ressource hat eine eigene Referenzseite. Das auf jeder Seite festgelegte Verb stimmt mit den von uip resource registrierten Befehlen überein – führen Sie uip resource --help aus, um die vollständige Oberfläche Ihrer Installation zu bestätigen.

RessourceZweck
AssetsBenannte Konfigurationswerte (Text, Bool, Integer, Anmeldeinformationen, Geheimnis), die von Automatisierungen zur Runtime verwendet werden. Ordnerbezogenen.
BucketsSpeichercontainer für Dateien, die von Automatisierungen verwendet werden. Ordnerbezogenen.
Bucket-DateienEinzelne Dateien in einem Bucket. Auflisten, Hochladen, Herunterladen, Löschen und Abrufen von vorsignierten URLs.
BibliothekenWiederverwendbare .nupkg -Pakete (gemeinsame Aktivitäten und Logik). Mandantenbezogenen.
WarteschlangenContainer für transaktionale Arbeitselemente. Ordnerbezogenen.
WarteschlangenelementeEinzelne Transaktionen innerhalb von Warteschlangen mit vollständigen State-Machine-Steuerelementen. Ordnerbezogenen.
AuslöserZeit, Warteschlange und API-Trigger, die Aufträge starten. Zeit-/Warteschlangentrigger haben einen Ordner-Scope; API-Trigger haben einen Mandanten-Scope.
WebhooksHTTP-Rückrufe, die bei Plattformereignissen ausgelöst werden (Auftragsabschluss, Fehler bei Warteschlangenelementen, …). Mandantenbezogenen.

Zusammenfassung

uip resource <resource> <verb> [options]
uip resource <resource> <verb> [options]

Die Standardausgabe ist JSON. Jeder Unterbefehl berücksichtigt die globalen Optionen (--output, --output-filter, --log-level, --log-file) und gibt die Standardbeendigungscodes zurück.

Konventionen

  • Authentifizierung. Jeder uip resource -Unterbefehl ruft Orchestrator auf. Führen Sie zuerst uip login aus oder übergeben Sie -t, --tenant <tenant-name> in einem beliebigen Unterbefehl, um einen bestimmten Mandanten innerhalb Ihrer authentifizierten Organisation anzuvisieren.
  • Ordner-Scoping. Assets, Buckets, Warteschlangen, Warteschlangenelemente und Trigger (Zeit/Warteschlange) sind ordnerbezogenen. Geben Sie entweder --folder-path <path> (z. B "Shared") oder --folder-key <guid> für list, create und verwandte Aufrufe. get, update und delete lösen ordnerübergreifend nach Schlüssel auf, wenn möglich – die Beschreibung jedes Verbs auf der Ressourcenseite ruft es explizit auf. Bibliotheken, API-Trigger und Webhooks haben einen Mandanten-Scope und akzeptieren --folder-* nicht.
  • Schlüssel. Die meisten Ressourcen werden durch eine GUID identifiziert, die in der list -Ausgabe zurückgegeben wird (unter key, identifier oder – für Warteschlangenelemente – uniqueKey für einen einzelnen Versuch und key für die Wiederholungskette). Numerische id -Felder sind intern und sollten nicht an Befehle übergeben werden.
  • Paginieren. Listenverben akzeptieren -l, --limit <n>, --offset <n> und --order-by <field> (OData-Syntax, z. B "Name asc"). Die Bucket-Datei list ist die Ausnahme und verwendet eine continuationToken.
  • Filtern. Sofern unterstützt, ist -n, --name <name> eine Enthält-Übereinstimmung für den Ressourcennamen; Einige Ressourcen fügen --enabled, --disabled, --status usw. hinzu.

Datenform

Eine erfolgreiche Ausgabe folgt immer dem Standardumschlag:

{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}
{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}

Der Code pro Verb wird auf der Ressourcenseite dokumentiert (AssetList, AssetCreated, BucketFile, QueueItemAdded, TriggerEnabled, WebhookPinged usw.). Data ist entweder ein einzelnes Objekt (get, create, update) oder ein Array (list, versions, event-types, history).

Auflistungen sind derzeit entpackt – sie enthalten kein count oder nextPage -Feld der obersten Ebene. Die Bucket-Datei list ist die Ausnahme; Die Nutzlast enthält continuationToken die für das Paginieren verwendet werden.

Funktionierte Beispiele

Listen Sie Warteschlangen in einem Ordner auf

uip resource queues list --folder-path Shared
uip resource queues list --folder-path Shared

Erstellen Sie ein Asset und geben Sie es dann für mehrere Ordner frei

uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production
uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production

Fügen Sie Warteschlangenelemente aus einer JSON-Datei massenweise hinzu

ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json
ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json
  • uip solution deploy config link – Binden Sie die deklarierte Ressource einer Lösung an eines der Assets/Warteschlangen/Buckets, die über uip resource erstellt wurden.
  • uip solution resource list – Überprüfen Sie die Ressourcendeklarationen innerhalb einer lokalen Lösung.
  • uip or – Für Ordner, Prozesse, Releases, Aufträge, Maschinen, Benutzer und Anmeldeinformationsspeicher, aus denen Sie bei der Verwendung von uip resource häufig Schlüssel suchen müssen.

Siehe auch

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben