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

UIP oder Warteschlangen

Syntax und Optionen für „uip or queuees“, die Orchestrator-Warteschlangencontainer für transaktionale Arbeitselemente verwaltet.

Orchestrator- Warteschlangen verwalten – Container für Arbeitselemente, die Automatisierungen transaktional verarbeiten. Warteschlangen haben einen Ordner-Scope. Informationen zu Vorgängen pro Element innerhalb einer Warteschlange finden Sie unter uip or queue-items.

Die ressourcenübergreifenden Konventionen (Authentifizierung, Ordner-Scoping, Schlüsseltypen, Ausgabeumschlag) finden Sie in der uip or -Übersicht.

Zusammenfassung​

uip or queues list         --folder-path <path> | --folder-key <key> | --all-folders [-n, --name <name>] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or queues get          <queue-key> [--all-fields]
uip or queues create       <name> --folder-path <path> | --folder-key <key> [options below]
uip or queues update       <queue-key> [options as for create]
uip or queues delete       <queue-key> --yes [-f]
uip or queues get-stats    --key <queue-key> [--folder-path <path> | --folder-key <key>] [-n <name>] [--from <date>] [--to <date>] [--all-fields]
uip or queues get-folders  <queue-key> [--all-fields]
uip or queues share        <queue-key> --folder-path <path> | --folder-key <key>
uip or queues unshare      <queue-key> --folder-path <path> | --folder-key <key>
uip or queues list         --folder-path <path> | --folder-key <key> | --all-folders [-n, --name <name>] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or queues get          <queue-key> [--all-fields]
uip or queues create       <name> --folder-path <path> | --folder-key <key> [options below]
uip or queues update       <queue-key> [options as for create]
uip or queues delete       <queue-key> --yes [-f]
uip or queues get-stats    --key <queue-key> [--folder-path <path> | --folder-key <key>] [-n <name>] [--from <date>] [--to <date>] [--all-fields]
uip or queues get-folders  <queue-key> [--all-fields]
uip or queues share        <queue-key> --folder-path <path> | --folder-key <key>
uip or queues unshare      <queue-key> --folder-path <path> | --folder-key <key>

Liste​

Listen Sie Warteschlangen in einem Ordner oder in jedem zugänglichen Ordner mit --all-folders auf. Geben Sie genau eines von --folder-path, --folder-key oder --all-folders an. Gibt den Warteschlangennamen, den Schlüssel (GUID), die Elementanzahlen und die Verarbeitungsstatistiken zurück.

Filtern Sie nach Name mit -n, --name <name> (Enthält Übereinstimmung). --sort-by <field> sortiert Ergebnisse (Standard: Id desc). --all-fields gibt die vollständige API-Nutzlast zurück.

uip or queues list --folder-path Shared
uip or queues list --all-folders --name Invoice
uip or queues list --folder-path Shared
uip or queues list --all-folders --name Invoice

Warteschlangendetails nach Schlüssel abrufen. Ordnerübergreifend. --all-fields gibt die vollständige API-Nutzlast zurück.

Erstellen​

Erstellen Sie eine Warteschlange in einem Ordner. Erfordert <name>. Flags: -d, --description, --max-retries, --sla-in-minutes <minutes>, --risk-sla-in-minutes <minutes>, --auto-retry / --no-auto-retry (Standard ein), --retry-abandoned-items / --no-retry-abandoned-items, --enforce-unique-reference / --no-enforce-unique-reference, --encrypted.

AufbewahrungsFlags:

MarkierenStandardBeschreibung
--retention-action <Delete|Archive|None>DeleteAktion für abgeschlossene Elemente. Archive erfordert --retention-bucket.
--retention-period <days>30Aufbewahrungszeitraum für abgeschlossene Elemente.
--retention-bucket <bucket-key>–Speicher-Bucket-Schlüssel (GUID) für archivierte abgeschlossene Elemente. Erforderlich, wenn --retention-action Archive ist. Der Bucket muss sich im Warteschlangenordner befinden oder für diesen freigegeben sein. Holen Sie sich den Schlüssel von uip or buckets list.
--stale-retention-action <Delete|Archive|None>DeleteAktion für nicht abgeschlossene Elemente. Archive erfordert --stale-retention-bucket.
--stale-retention-period <days>180Aufbewahrungszeitraum für nicht abgeschlossene Elemente.
--stale-retention-bucket <bucket-key>–Speicher-Bucket-Schlüssel (GUID) für archivierte nicht abgeschlossene Elemente. Erforderlich, wenn --stale-retention-action Archive ist. Der Bucket muss sich im Warteschlangenordner befinden oder für diesen freigegeben sein. Holen Sie sich den Schlüssel von uip or buckets list.
uip or queues create InvoiceQueue --folder-path Shared \
  --max-retries 3 --retention-period 90

# Archive completed items to a storage bucket
uip or queues create InvoiceQueue --folder-path Shared \
  --retention-action Archive --retention-bucket b1b2c3d4-0000-0000-0000-000000000001
uip or queues create InvoiceQueue --folder-path Shared \
  --max-retries 3 --retention-period 90

# Archive completed items to a storage bucket
uip or queues create InvoiceQueue --folder-path Shared \
  --retention-action Archive --retention-bucket b1b2c3d4-0000-0000-0000-000000000001

Aktualisieren​

Aktualisieren Sie die Warteschlangeneigenschaften nach Schlüssel. Ordnerübergreifend. Nur die von Ihnen angegebenen Felder ändern sich. Akzeptiert -n, --name <name> zum Umbenennen der Warteschlange sowie dieselben Flags wie create, alle optional und ohne Standardwerte.

Die Archivaufbewahrung benötigt einen Speicher-Bucket. Das Wechseln --retention-action oder --stale-retention-action zu Archive erfordert --retention-bucket oder --stale-retention-bucket , es sei denn, die Warteschlange archiviert diese Elemente bereits. Lassen Sie das Bucket-Flag weg, um den aktuellen Bucket beizubehalten. Wenn sich die Aktion zu Delete oder None ändert, wird der Bucket gelöscht.

Löschen​

Löschen Sie eine Warteschlange nach Schlüssel. Ordnerübergreifend. Erfordert -y, --yes – die CLI fordert nie zu destruktiven Vorgängen auf. Fügen Sie -f, --force hinzu, um eine Warteschlange zu löschen, die noch Elemente enthält – ohne das wird eine nicht leere Warteschlange abgelehnt; --force löscht die Elemente zusammen mit der Warteschlange und impliziert --yes.

uip or queues delete a1b2c3d4-0000-0000-0000-000000000010 --yes
uip or queues delete a1b2c3d4-0000-0000-0000-000000000010 --yes

Get-Stats​

Rufen Sie Verarbeitungsstatistiken (Elementanzahl, Ausnahmeanzahl, Verarbeitungszeiten) für eine Warteschlange ab. Im Gegensatz zu jedem anderen Verb auf dieser Seite wird die Warteschlange durch eine erforderliche Option und nicht durch ein Positionsargument identifiziert: --key <queue-key>. Optional -n, --name <name> (enthält Übereinstimmung, kombiniert mit --key), --from <date> / --to <date> (ISO 8601, Filtern nach letztem Verarbeitungsdatum), --all-fields.

uip or queues get-stats --key a1b2c3d4-0000-0000-0000-000000000001
uip or queues get-stats --key a1b2c3d4-0000-0000-0000-000000000001

Ordner abrufen, freigeben, freigeben​

Dieselbe Semantik wie die Asset- und Bucket-Gegenstück – siehe assets und buckets für das gemeinsam genutzte Modell.

Exitcodes​

Siehe Austrittscodes für den gemeinsamen Vertrag. delete beendet 1, wenn -y, --yes weggelassen wird.

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support(opens in new window)

Möchten Sie lernen? UiPath Academy(opens in new window)

Haben Sie Fragen? UiPath-Forum(opens in new window)

Auf dem neuesten Stand bleiben