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 oder Ordner

uip or folders verwaltet Orchestrator-Ordner – die hierarchischen Container, die Prozesse, Aufträge, Assets, Warteschlangen und Benutzerberechtigungen umfassen. Verben decken das Auflisten, Erstellen, Verschieben, Bearbeiten und Löschen von Ordnern sowie einen runtimes -Befehl ab, der die Maschinen-Laufzeit-Zuweisung innerhalb eines Ordners meldet.

Zusammenfassung

uip or folders <verb> [options]
uip or folders <verb> [options]

Verben

VerbZweck
listListen Sie Ordner auf. Standard: Ordner, auf die der aktuelle Benutzer zugreifen kann; mit --all, jedem Ordner im Mandanten.
createErstellen Sie einen Ordner, der optional unter einem übergeordneten Ordner verschachtelt ist.
getRufen Sie einen Ordner nach Schlüssel oder Pfad ab.
deleteLöschen Sie einen Ordner nach Schlüssel oder Pfad.
moveÜbergeordnete Elemente eines Ordners oder Verschieben in das Stammverzeichnis.
editAktualisieren Sie den Anzeigenamen und/oder die Beschreibung.
runtimesZeigen Sie die Runtime-Zuweisung (insgesamt/verbunden/verfügbar) pro Runtime-Typ für einen Ordner an.

UIP oder Ordnerliste

Listen Sie Ordner auf. Die Standardansicht verwendet GetAllForCurrentUser – Ordner, auf die der Aufrufer Zugriff hat. Mit --all wechselt das Verb zum vollständigen Folders -Endpunkt (Standard- und Lösungsordner im Mandanten); Mit --type personal wird zum Endpunkt PersonalWorkspaces gewechselt. Das Filtern und Sortieren von Flags (--name, --path, --type, --top-level, --order-by) erfordert --all.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-a--allMarkierenausAlle Ordner im Mandanten auflisten; erforderlich, um den Filter und die Sortier-Flags unten zu aktivieren.
-n--nametextEnthält Übereinstimmung für Anzeigenamen. Erfordert --all.
--pathPfadpräfixFiltern Sie nach dem Präfix des Ordnerpfads (z. B. Shared entspricht Shared und allem, was darunter liegt). Erfordert --all.
--typeENUMstandard, solution oder personal. Erfordert --all. personal wechselt zum Endpunkt der persönlichen Arbeitsbereiche.
--top-levelMarkierenausNur Stammordner (kein übergeordnetes Ordner). Erfordert --all. Nicht mit --type personal unterstützt.
-l--limitNummer50Seitengröße.
--offsetNummer0Anzahl der Überspringungen.
--order-byFeldOData-Sortierung (z. B. Name asc). Erfordert --all.
--login-validityMinuten10Mindestens Minuten vor dem Tokenablauf, der eine Aktualisierung vor der Anforderung auslöst.

Beispiele

# Folders the authenticated user can access
uip or folders list

# All tenant folders, filtered and sorted
uip or folders list --all --type standard --name "Prod" --order-by "Name asc"

# Personal workspaces only
uip or folders list --all --type personal
# Folders the authenticated user can access
uip or folders list

# All tenant folders, filtered and sorted
uip or folders list --all --type standard --name "Prod" --order-by "Name asc"

# Personal workspaces only
uip or folders list --all --type personal

Datenform (--output json)

{
  "Code": "FolderList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Shared",
      "Path": "Shared",
      "Description": "",
      "Type": "Standard",
      "ParentKey": ""
    }
  ]
}
{
  "Code": "FolderList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Shared",
      "Path": "Shared",
      "Description": "",
      "Type": "Standard",
      "ParentKey": ""
    }
  ]
}

Mit --all enthalten die Elemente auch FeedType und PermissionModel. Mit --type personal ist die Nutzlast { Key, Name, OwnerName, OwnerKey, LastLogin }.

UIP oder Ordner erstellen

Erstellen Sie einen Ordner, der optional unter einem übergeordneten Ordner verschachtelt ist. --parent akzeptiert entweder eine Ordner-GUID oder einen Pfad (Shared, Production/EU).

Argumente

NameErforderlichZweck
<name>jaAnzeigename des Ordners.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-d--descriptiontextOrdnerbeschreibung.
-p--parentSchlüssel oder PfadÜbergeordneter Ordner nach GUID oder Pfad. Für einen Stammordner weglassen.
--feed-typeENUMProcessesProcesses, Libraries, FolderHierarchy.
--permission-modelENUMFineGrainedFineGrained oder InheritFromTenant.
--provision-typeENUMAutomaticAutomatic oder Manual.

Beispiele

uip or folders create "Staging"

uip or folders create "EU" --parent "Production" \
    --description "European workloads"

uip or folders create "Libraries" --feed-type Libraries \
    --permission-model InheritFromTenant
uip or folders create "Staging"

uip or folders create "EU" --parent "Production" \
    --description "European workloads"

uip or folders create "Libraries" --feed-type Libraries \
    --permission-model InheritFromTenant

Datenform (--output json)

{
  "Code": "FolderCreated",
  "Data": {
    "Name": "Staging",
    "ID": 103,
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Created successfully"
  }
}
{
  "Code": "FolderCreated",
  "Data": {
    "Name": "Staging",
    "ID": 103,
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Created successfully"
  }
}

UIP oder Ordner abrufen

Rufen Sie einen Ordner nach Schlüssel oder Pfad ab. Das Positionsargument erkennt automatisch: Eine UUID-Eingabe wird als Schlüssel behandelt, alles andere als Pfad.

Argumente

NameErforderlichZweck
<folder-key-or-path>jaOrdner-GUID oder Pfad.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.

Beispiele

uip or folders get "Shared"
uip or folders get a1b2c3d4-0000-0000-0000-000000000001
uip or folders get "Shared/Staging" --output-filter 'Data.Key'
uip or folders get "Shared"
uip or folders get a1b2c3d4-0000-0000-0000-000000000001
uip or folders get "Shared/Staging" --output-filter 'Data.Key'

Datenform (--output json)

{
  "Code": "FolderGet",
  "Data": {
    "Name": "Shared",
    "ID": 101,
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "Description": "No description",
    "Path": "Shared",
    "ParentID": "Root",
    "FolderType": "Standard",
    "IsPersonal": "No",
    "ProvisionType": "Automatic",
    "PermissionModel": "FineGrained",
    "FeedType": "Processes"
  }
}
{
  "Code": "FolderGet",
  "Data": {
    "Name": "Shared",
    "ID": 101,
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "Description": "No description",
    "Path": "Shared",
    "ParentID": "Root",
    "FolderType": "Standard",
    "IsPersonal": "No",
    "ProvisionType": "Automatic",
    "PermissionModel": "FineGrained",
    "FeedType": "Processes"
  }
}

UIP oder Ordner löschen

Löschen Sie einen Ordner nach Schlüssel oder Pfad. Schlägt fehl, wenn der Ordner Entitäten oder Benutzerzuordnungen enthält – zuerst Inhalte entfernen oder verschieben.

Argumente

NameErforderlichZweck
<folder-key-or-path>jaOrdner-GUID oder Pfad.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.

Beispiele

uip or folders delete "Shared/Staging"
uip or folders delete a1b2c3d4-0000-0000-0000-000000000010
uip or folders delete "Shared/Staging" --output-filter 'Data.Status'
uip or folders delete "Shared/Staging"
uip or folders delete a1b2c3d4-0000-0000-0000-000000000010
uip or folders delete "Shared/Staging" --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "FolderDelete",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Deleted successfully"
  }
}
{
  "Code": "FolderDelete",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Deleted successfully"
  }
}

UIP oder Ordner verschieben

Verschieben Sie einen Ordner in einen neuen übergeordneten Ordner oder hoch zum Stammordner. Sie müssen genau eines von --parent und --root angeben.

Argumente

NameErforderlichZweck
<folder-key-or-path>jaOrdner-GUID oder zu verschiebender Pfad.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-p--parentSchlüssel oder PfadNeuer übergeordneter Ordner. Erforderlich, es sei denn, --root ist festgelegt.
--rootMarkierenausZur obersten Ebene wechseln (kein übergeordnetes Element).

Beispiele

uip or folders move "Shared/Staging" --parent "Production"
uip or folders move a1b2c3d4-0000-0000-0000-000000000010 --root
uip or folders move "Shared/Staging" --parent "Production" \
    --output-filter 'Data.TargetParentPath'
uip or folders move "Shared/Staging" --parent "Production"
uip or folders move a1b2c3d4-0000-0000-0000-000000000010 --root
uip or folders move "Shared/Staging" --parent "Production" \
    --output-filter 'Data.TargetParentPath'

Datenform (--output json)

{
  "Code": "FolderMove",
  "Data": {
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "FolderPath": "Shared/Staging",
    "TargetParentPath": "Production",
    "Status": "Moved successfully"
  }
}
{
  "Code": "FolderMove",
  "Data": {
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "FolderPath": "Shared/Staging",
    "TargetParentPath": "Production",
    "Status": "Moved successfully"
  }
}

--root legt TargetParentPath auf (root) fest.

UIP oder Ordner bearbeiten

Aktualisieren Sie den Anzeigenamen und/oder die Beschreibung. Von den Optionen --name und --description muss mindestens eine bereitgestellt werden.

Argumente

NameErforderlichZweck
<folder-key-or-path>jaOrdner-GUID oder Pfad.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
-n--nametextNeuer Anzeigename.
-d--descriptiontextNeue Beschreibung.

Beispiele

uip or folders edit a1b2c3d4-0000-0000-0000-000000000010 --name "Staging (EU)"
uip or folders edit "Shared/Staging" --description "Pre-prod runs"
uip or folders edit "Shared/Staging" --name "Staging (EU)" --output-filter 'Data.Status'
uip or folders edit a1b2c3d4-0000-0000-0000-000000000010 --name "Staging (EU)"
uip or folders edit "Shared/Staging" --description "Pre-prod runs"
uip or folders edit "Shared/Staging" --name "Staging (EU)" --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "FolderUpdate",
  "Data": { "Status": "Updated successfully" }
}
{
  "Code": "FolderUpdate",
  "Data": { "Status": "Updated successfully" }
}

UIP- oder Ordner-Runtimes

Listen Sie die Runtime-Zuweisung für einen Ordner auf – für jeden Runtime-Typ, wie viele Slots insgesamt, verbunden und verfügbar sind. Nützlich zur Überprüfung der Kapazität vor dem Starten von Aufträgen.

Argumente

NameErforderlichZweck
<folder-key-or-path>jaOrdner-GUID oder Pfad.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.

Beispiele

uip or folders runtimes "Shared"
uip or folders runtimes a1b2c3d4-0000-0000-0000-000000000001
uip or folders runtimes "Shared" \
    --output-filter "Data[?Type=='Unattended'].Available | [0]"
uip or folders runtimes "Shared"
uip or folders runtimes a1b2c3d4-0000-0000-0000-000000000001
uip or folders runtimes "Shared" \
    --output-filter "Data[?Type=='Unattended'].Available | [0]"

Datenform (--output json)

{
  "Code": "FolderRuntimes",
  "Data": [
    { "Type": "Unattended", "Total": 4, "Connected": 3, "Available": 1 },
    { "Type": "NonProduction", "Total": 2, "Connected": 1, "Available": 1 }
  ]
}
{
  "Code": "FolderRuntimes",
  "Data": [
    { "Type": "Unattended", "Total": 4, "Connected": 3, "Available": 1 },
    { "Type": "NonProduction", "Total": 2, "Connected": 1, "Available": 1 }
  ]
}

Exitcodes

Siehe Exitcodes. Keine Verb-spezifischen Überschreibungen.

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