UIP-Aufgaben

Befehle zum Verwalten von Action Center-Aufgaben, Katalogen, Kommentaren, Beschriftungen, Metadaten und Aufgabendaten mit dem Tool „uip task“.

uip tasks verwaltet Action Center Aufgaben – die Human-in-the-Loop-Arbeitselemente (Formularausfüllen, Genehmigungen, Dokumentvalidierung/Klassifizierung, Datenbeschriftung), die RPA-Prozesse und Agents für den Abschluss einer Person erstellen. Mit dem Tool können Sie Aufgaben auflisten und überprüfen, sie zuweisen oder neu zuweisen, sie mit einer Aktion und Datennutzlast abschließen und die an einer Aufgabe angehängten Hilfsressourcen verwalten: Kataloge (Gruppierungs-/Aufbewahrungskonfiguration), Kommentare, Beschriftungen (Tags), Metadaten ( Titel/Priorität/Kataloglink) und die eigenen Formular-/Geschäftsdaten der Aufgabe. tasks ist das Befehlspräfix Das zugrunde liegende Paket ist @uipath/tasks-tool.

Konzepte

• Ordner-Scoping – jedes Verb, das mit einer bestimmten Aufgabe oder einem bestimmten Katalog arbeitet, akzeptiert --folder-id <id>, --folder-path <path> oder --folder-key <key> (sie schließen sich gegenseitig aus; wird zum Parsezeitpunkt über Befehlskonflikte erzwungen). Wenn keiner an ein interaktives Terminal übergeben wird, zeigt die CLI eine Ordnerauswahl an; In einer nicht interaktiven Ausführung (CI, Codierungsagents) schlägt die Suche nach einem schnell fehl. uip tasks list und uip tasks get sind die beiden Ausnahmen – ein Ordner ist dort optional und schränkt die Ergebnisse/Suche einfach ein, wenn er angegeben ist.
• Aufgabentyp – mehrere Verben (get --task-type, complete --type) nehmen eines von FormTask, ExternalTask, AppTask, DocumentValidationTask, DocumentClassificationTask, DataLabelingTask, QuickFormTask. Ein nicht erkannter Wert schlägt clientseitig mit der vollständigen Liste fehl, die im Fehler benannt ist.
• Paginierung – Verben im Listenstil (list, catalogs list, comments list, users) intern mit einer Seitengröße von 100 Elementen und folgen nextCursor bis es erschöpft ist oder --limit erreicht ist, wodurch ein flaches Array zurückgegeben wird so oder so – es gibt kein Cursor-Flag, um sich selbst zu verwalten.
• Kataloge sind eine optionale Gruppierungs-/Aufbewahrungskonfiguration für Aufgaben – metadata --catalog-id verknüpft eine Aufgabe mit einer; Die Aufbewahrungsfelder (--retention-action, --retention-period, --retention-bucket-id) von catalogs create/update steuern, was mit den Katalogdaten im Laufe der Zeit geschieht. --encrypted in catalogs create ist unveränderlich – es gibt keine Möglichkeit, dies über catalogs update zu ändern.

Zusammenfassung

uip tasks list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [--as-admin] [-l, --limit <n>]
uip tasks get <id> [--task-type <type>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks assign <task-id> (--user-id <id> | --user <email>)
uip tasks reassign <task-id> (--user-id <id> | --user <email>)
uip tasks unassign <task-id>
uip tasks complete <task-id> --type <type> [--data <json>] [--action <action>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks users [folder-id] [--folder-path <path> | --folder-key <key>] [-l, --limit <n>]

uip tasks catalogs list [--folder-id <id> | --folder-path <path> | --folder-key <key>] [-l, --limit <n>]
uip tasks catalogs get <id> [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs create --name <name> [--description <text>] [--encrypted] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]
uip tasks catalogs update <id> [--name <name>] [--description <text>] [--retention-action <action>] [--retention-period <days>] [--retention-bucket-id <id>] [--folder-id <id> | --folder-path <path> | --folder-key <key>]

uip tasks comments list <task-id> [-l, --limit <n>] [folder options]
uip tasks comments add <task-id> --text <text> [folder options]

uip tasks labels <task-id> --labels <json> [folder options]
uip tasks metadata <task-id> [--title <text>] [--priority <level>] [--catalog-id <id> | --unset-catalog] [--note <text>] [folder options]

uip tasks data get <task-id> [folder options]
uip tasks data save <task-id> --data <json> [folder options]

UIP-Aufgabenliste

Listen Sie Aufgaben über Ordner hinweg auf (oder in einem Ordner, wenn sie Scope hat).

Optionen

Long	Wert	Beschreibung
--folder-id <id>	Integer	Filtern Sie nach Ordner-ID.
--folder-path <path>	string	Nach Ordnerpfad filtern (Alternativ zu --folder-id).
--folder-key <key>	GUID	Filtern Sie nach Ordnerschlüssel (Alternative zu --folder-id).
--as-admin	Markieren	Listen Sie Aufgaben als Administrator auf (breitere Sichtbarkeit als Ihre eigenen zugewiesenen/verfügbaren Aufgaben).
-l, --limit <number>	Integer	Maximale Anzahl der zurückzugebenden Elemente. Ruft alles ab (intern paginieren), wenn es weggelassen wird.

Beispiel

uip tasks list --folder-path "Shared/Finance" --limit 20

Datenform (--output json)

{ "Code": "TaskList", "Data": [ { "id": 1, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } ] }

UIP-Aufgaben abrufen

Ruft Details einer Aufgabe nach ID ab.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Aufgaben-ID. Verwenden Sie tasks list, um einen zu finden.

Optionen

Long	Wert	Beschreibung
--task-type <type>	einer der 7 Aufgabentypen	Aufgabentyp. Erfordert eine Ordneroption, wenn sie übergeben wird – schlägt andernfalls schnell fehl.
--folder-id <id> / --folder-path <path> / --folder-key <key>		Ordner-Scope. Nur erforderlich, wenn --task-type festgelegt ist.

Beispiel

uip tasks get 123 --task-type FormTask --folder-id 42

Datenform (--output json)

{ "Code": "TaskDetails", "Data": { "id": 123, "title": "Approve invoice", "type": "FormTask", "status": "Pending" } }

UIP-Aufgaben zuweisen/neu zuweisen

Weisen Sie einem Benutzer eine Aufgabe zu oder weisen Sie sie einer anderen neu zu – identische Optionsform, andere Code bei Erfolg.

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--user-id <id>	Integer	eines dieser beiden	Numerische Benutzer-ID des Beauftragten.
--user <email>	string	eines dieser beiden	Benutzername oder E-Mail-Adresse des Beauftragten (Alternativ zu --user-id).

Das Übergeben von beiden schlägt mit einem expliziten „Fehlender Beauftragter“ fehl Dieser Fehler

Beispiel

uip tasks assign 123 --user [e-mail]
uip tasks reassign 123 --user-id 7

Datenform (--output json)

{ "Code": "TaskAssigned", "Data": { "id": 123, "assignedTo": "[e-mail]" } }

Code ist TaskReassigned für reassign.

Die Zuweisung von UIP-Aufgaben wird aufgehoben

Entfernen Sie den Beauftragten von einer Aufgabe. Keine Optionen über die Aufgaben-ID hinaus.

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Beispiel

uip tasks unassign 123

Datenform (--output json)

{ "Code": "TaskUnassigned", "Data": { "id": 123 } }

UIP-Aufgaben abgeschlossen

Führen Sie eine Aufgabe mit einer Aktion und einer optionalen Datennutzlast aus.

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--type <type>	einer der 7 Aufgabentypen	ja	Aufgabentyp – clientseitig anhand der Aufzählung validiert.
--data <json>	JSON	nein	Aufgabendatennutzlast als JSON-Zeichenfolge.
--action <action>	string	bedingt	Aktionsname. In der Praxis für FormTask und AppTask erforderlich (nicht auf Clientseite erzwungen – die Plattform weist eine fehlende Aktion für diese Typen zurück).
Ordneroptionen		nein	Ein Ordner wird aufgelöst (interaktiv, wenn er ausgelassen wird, mit einem Tty), bevor er abgeschlossen wird.

Beispiel

uip tasks complete 123 --type FormTask --action Approve --data '{"comment":"Looks good"}'

Datenform (--output json)

{ "Code": "TaskCompleted", "Data": { "id": 123, "status": "Completed" } }

uip task-Benutzer

Listen Sie Benutzer mit Aufgabenberechtigungen in einem Ordner auf – die Quelle für --user-id/--user -Werte auf assign/reassign.

Argumente

Name	Erforderlich	Zweck
[folder-id]	nein	Ordner-ID als Positionsargument. Sich gegenseitig mit --folder-path/--folder-key ausschließend – die Übergabe beider Optionen schlägt explizit fehl.

Optionen

Long	Wert	Beschreibung
--folder-path <path>	string	Ordnerpfad (Alternative zum Positionsargument).
--folder-key <key>	GUID	Ordnerschlüssel (Alternative zum Positionsargument).
-l, --limit <number>	Integer	Maximale Anzahl der zurückzugebenden Elemente.

Beispiel

uip tasks users 42
uip tasks users --folder-path "Shared/Finance" --limit 10

Datenform (--output json)

{
  "Code": "TaskUserList",
  "Data": [
    { "id": 1, "name": "Alice", "surname": "Smith", "userName": "alice", "emailAddress": "[e-mail]", "displayName": "Alice Smith" }
  ]
}

UIP-Aufgabenkataloge

Verwalten von Aufgabenkatalogen – benannte Aufgabengruppen mit optionaler Verschlüsselung und Aufbewahrungsrichtlinie.

UIP-Aufgabenkatalogliste

Optionen

Long	Wert	Beschreibung
Ordneroptionen		Ordner, in dem Kataloge aufgelistet werden sollen (ein Ordner wird aufgelöst, wenn er weggelassen wird, gemäß Konzepten).
-l, --limit <number>	Integer	Maximale Anzahl der zurückzugebenden Elemente.

Beispiel

uip tasks catalogs list --folder-id 42

Datenform (--output json)

{ "Code": "TaskCatalogList", "Data": [ { "id": 5, "name": "Invoices", "encrypted": false } ] }

Abrufen von UIP-Aufgabenkatalogen

Argumente

Name	Erforderlich	Zweck
<id>	ja	Aufgabenkatalog-ID.

Beispiel

uip tasks catalogs get 5 --folder-id 42

Datenform (--output json)

{ "Code": "TaskCatalogDetails", "Data": { "id": 5, "name": "Invoices", "encrypted": false } }

UIP-Aufgabenkataloge erstellen

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Katalogname.
--description <text>	string	nein	Katalogbeschreibung.
--encrypted	Markieren	nein	Verschlüsseln Sie Aufgabendaten in diesem Katalog. Unveränderlich – kann später nicht von catalogs update geändert werden.
--retention-action <action>	Delete | Archive	nein	Was passiert an der Aufbewahrungsgrenze. Jeder andere Wert schlägt auf der Clientseite fehl.
--retention-period <days>	Integer	nein	Aufbewahrungszeitraum in Tagen.
--retention-bucket-id <id>	Integer	nein	Speicher-Bucket-ID, die bei --retention-action Archive verwendet wird.

Beispiel

uip tasks catalogs create --name Invoices --retention-action Archive --retention-period 90 --retention-bucket-id 3 --folder-id 42

Datenform (--output json)

{ "Code": "TaskCatalogCreated", "Data": { "id": 5, "name": "Invoices" } }

Aktualisierung der UIP-Aufgabenkataloge

Zusammenführungen – nur die Flags, die Sie übergeben, ändern sich. Mindestens eines von --name/--description/--retention-action/--retention-period/--retention-bucket-id ist erforderlich; der Aufruf mit keinem schlägt fehl, bevor ein Datei-/Netzwerkzugriff erfolgt. --encrypted kann hier nicht geändert werden.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Aufgabenkatalog-ID.

Optionen

Derselbe Satz wie create minus --encrypted.

Beispiel

uip tasks catalogs update 5 --name "Invoices v2" --folder-id 42

Datenform (--output json)

{ "Code": "TaskCatalogUpdated", "Data": { "id": 5, "name": "Invoices v2" } }

Kommentare zu UIP-Aufgaben

Kommentarliste für UIP-Aufgaben

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Optionen

Long	Wert	Beschreibung
-l, --limit <number>	Integer	Maximale Anzahl der zurückzugebenden Elemente.
Ordneroptionen		Ordner, in dem sich die Aufgabe befindet.

Beispiel

uip tasks comments list 123 --folder-id 42

Datenform (--output json)

{ "Code": "TaskCommentList", "Data": [ { "id": 1, "text": "Looks good", "createdBy": "alice" } ] }

UIP-Aufgaben Kommentare hinzufügen

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--text <text>	string	ja	Kommentartext. Leere Zeichenfolge wird abgelehnt.
Ordneroptionen		nein	Ordner, in dem sich die Aufgabe befindet.

Beispiel

uip tasks comments add 123 --text "Escalating to finance" --folder-id 42

Datenform (--output json)

{ "Code": "TaskCommentCreated", "Data": { "id": 2, "text": "Escalating to finance" } }

Beschriftungen für UIP-Aufgaben

Festlegen oder Löschen der Beschriftungen (Tags) für eine Aufgabe mit einem Aufruf – dies ist ein vollständiger Ersatz, keine Zusammenführung; Übergeben Sie jede Beschriftung, die Sie beibehalten möchten.

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--labels <json>	JSON-Array	ja	Festzulegende Beschriftungen, z. B [{"name":"region","displayName":"Region","displayValue":"EMEA"}]). Übergeben Sie [], um alle Beschriftungen zu löschen. Muss ein JSON-Array sein – ein Nicht-Array-Wert schlägt auf Clientseite fehl.
Ordneroptionen		nein	Ordner, in dem sich die Aufgabe befindet.

Beispiel

uip tasks labels 123 --labels '[{"name":"region","displayName":"Region","displayValue":"EMEA"}]' --folder-id 42

Datenform (--output json)

{ "Code": "TaskLabelsSaved", "Data": { "taskId": 123, "labels": [{ "name": "region", "displayName": "Region", "displayValue": "EMEA" }] } }

Metadaten für UIP-Aufgaben

Bearbeiten Sie den Titel, die Priorität und den Kataloglink einer Aufgabe und zeichnen Sie einen Hinweis mit der Bearbeitung auf. Zusammenführungen – nur die Flags, die Sie übergeben, ändern sich; mindestens eine ist erforderlich.

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Optionen

Long	Wert	Beschreibung
--title <title>	string	Neuer Titel.
--priority <priority>	Low | Medium | High | Critical	Neue Priorität. Ein Out-of-Set-Wert schlägt auf der Clientseite fehl und benennen den gültigen Satz.
--catalog-id <id>	Integer	Ordnen Sie einen Aufgabenkatalog zu. Sich gegenseitig mit --unset-catalog ausschließen.
--unset-catalog	Markieren	Entfernen Sie die Katalogzuordnung der Aufgabe. Sich gegenseitig mit --catalog-id ausschließen.
--note <text>	string	Kommentar wurde neben der Bearbeitung aufgezeichnet.

Beispiel

uip tasks metadata 123 --priority High --note "Escalated per manager request" --folder-id 42

Datenform (--output json)

{ "Code": "TaskMetadataEdited", "Data": { "taskId": 123 } }

Daten zu UIP-Aufgaben

Lesen oder schreiben Sie das zugrunde liegende Formular/Geschäftsdatenobjekt einer Aufgabe.

Datenabruf für UIP-Aufgaben

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Beispiel

uip tasks data get 123 --folder-id 42

Datenform (--output json)

{ "Code": "TaskData", "Data": { "invoiceNumber": "INV-001", "amount": 250.0 } }

UIP-Aufgaben speichern Daten

Argumente

Name	Erforderlich	Zweck
<task-id>	ja	Aufgaben-ID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--data <json>	JSON-Objekt	ja	Zu speichernde Aufgabendaten. Muss ein JSON-Objekt sein (kein Array oder Skalar) – alles andere schlägt auf Clientseite fehl.

Beispiel

uip tasks data save 123 --data '{"invoiceNumber":"INV-001","amount":250.0}' --folder-id 42

Datenform (--output json)

{ "Code": "TaskDataSaved", "Data": { "taskId": 123 } }

Siehe auch

• Konzepte: Wie die UiPath CLI organisiert ist – wo Tools in das Host- und Toolmodell passen.
• Sitzungen – wie der Mandantenkontext aufgelöst wird.
• uip or folders – Auf dieser Seite finden Sie Ordner-IDs/Pfade/Schlüssel für die Ordner-Scoping-Optionen.
• uip login – Sitzung, die für alle Action Center-Aufrufe verwendet wird.
• Globale Optionen
• Exitcodes