UIP oder Aufträge

Syntax und Optionen für „uip oder Jobs“, die Orchestrator-Prozessausführungen und deren Protokolle starten, stoppen, neu starten und überprüfen.

uip or jobs verwaltet Prozessausführungen: Starten Sie Aufträge über Prozesse, halten Sie sie an und starten Sie sie neu, setzen Sie angehaltene Aufträge fort und überprüfen Sie Protokolle, Ablaufverfolgungen, Healing Agent-Daten und den Statusverlauf. Jeder Auftrag wird durch einen GUID-Schlüssel identifiziert, der global eindeutig ist – die meisten Verben lösen den Ordner automatisch aus dem Schlüssel auf.

Zusammenfassung

uip or jobs <verb> [options]

Verben

Verb	Zweck
list	Listen Sie Aufträge auf, optional auf einen Ordner beschränkt und nach Status, Prozess, Quelle oder Zeitbereich gefiltert.
get	Rufen Sie einen Auftrag nach Schlüssel ab, einschließlich Eingabe-/Ausgabeargumenten und (für ausstehende Aufträge) Diagnosegründe.
start	Einen oder mehrere Jobs für einen Prozess starten; Optional auf Abschluss warten und Ausgabe herunterladen.
stop	Sie können einen oder mehrere laufende/ausstehende Aufträge anhalten oder das Beenden erzwingen.
restart	Erstellen Sie einen neuen Auftrag aus einem fehlerhaften oder angehaltenen Auftrag.
resume	Setzen Sie einen angehaltenen Auftrag fort, optional mit aktualisierten Eingabeargumenten.
logs	Roboterausführungsprotokolle für einen Auftrag abrufen; Nach Ebene filtern oder in eine CSV-Datei exportieren.
traces	Rufen Sie LLMOps-Ausführungsablaufverfolgungen für einen agentischen Auftrag (Typ Agent) ab.
healing-data	Laden Sie Wiederherstellungsdaten von Healing Agent (Screenshots, UI-Daten, Protokolle) als ZIP herunter.
history	Statusübergänge für einen Auftrag anzeigen.

UIP oder Auftragsliste

List jobs in a folder, or across every accessible folder with --all-folders. Returns job key, state, process name, timing, and machine info. Exactly one of a folder selector (--folder-path/--folder-key) or --all-folders is required — the command refuses to run with both or with neither.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-path	Pfad	–	Scope to a folder by path (for example, Shared). Provide this, --folder-key, or --all-folders.
–	--folder-key	GUID	–	Scope auf einen Ordner nach Schlüssel.
–	--all-folders	Markieren	aus	List jobs across every accessible folder. Mutually exclusive with the folder selectors.
–	--state	ENUM	–	Pending, Running, Successful, Faulted, Stopped, Stopping, Suspended, Resumed, Terminating.
–	--process-name	text	–	Enthält Übereinstimmung für den Prozess-(Release)namen.
–	--source	ENUM	–	Filtern Sie nach Auftragsquellentyp (z. B. Manual, Schedule, Queue, Agent).
–	--created-after	ISO 8601	–	Aufträge, die an oder nach diesem Datum/Uhrzeit erstellt wurden.
–	--created-before	ISO 8601	–	Aufträge, die streng vor diesem Datum/Uhrzeit erstellt wurden.
–	--started-after	ISO 8601	–	Aufträge wurden an oder nach diesem Datum/Uhrzeit gestartet.
–	--started-before	ISO 8601	–	Aufträge wurden streng vor diesem Datum/Uhrzeit gestartet.
–	--ended-after	ISO 8601	–	Aufträge wurden an oder nach diesem Datum/Uhrzeit beendet.
–	--ended-before	ISO 8601	–	Aufträge wurden streng vor diesem Datum/dieser Uhrzeit beendet.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--sort-by	Feld	Id desc	OData-Sortierungsausdruck.
–	--all-fields	Markieren	aus	Geben Sie die vollständige API-Nutzlast anstelle der kuratierten Zusammenfassung zurück.

Beispiele

# The 50 most recent jobs across every accessible folder
uip or jobs list --all-folders

# Running jobs in a specific folder, newest first
uip or jobs list --folder-path "Shared" --state Running

# Pull only job keys and states, script-friendly
uip or jobs list --all-folders --state Faulted --limit 200 \
    --output-filter 'Data[].{key:Key, state:State}'

Datenform (--output json)

{
  "Code": "JobList",
  "Data": [
    {
      "Key": "b2c3d4e5-0000-0000-0000-000000000001",
      "State": "Running",
      "ProcessName": "InvoiceProcessing",
      "ReleaseKey": "c3d4e5f6-0000-0000-0000-000000000001",
      "Source": "Manual",
      "Type": "Unattended",
      "Priority": "Normal",
      "Machine": "prod-worker-01",
      "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
      "StartTime": "2025-04-15T10:30:00Z",
      "EndTime": "",
      "CreationTime": "2025-04-15T10:29:55Z"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

UIP oder Jobs abrufen

Rufen Sie einen Auftrag nach GUID-Schlüssel ab. Gibt Status, Eingabe-/Ausgabeargumente, Zeitpunkt, Maschineninformationen und Fehlerdetails zurück, wenn ein Fehler auftritt. Wenn der Status des Auftrags Pending ist, enthält die Ausgabe auch PendingReasons (den Diagnosebericht der API, warum der Auftrag nicht gestartet wurde – Roboterverfügbarkeit, Kapazität usw.). Es ist kein Ordnerkontext erforderlich.

Wenn der Auftrag ein OutputFile hat, wird er automatisch als output-<job-key>.dat in das aktuelle Verzeichnis (oder --output-dir) heruntergeladen. Übergeben Sie --no-download zum Überspringen.

Argumente

Name	Erforderlich	Zweck
<job-key>	ja	Auftragsschlüssel (GUID). Finden Sie es mit uip or jobs list.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--output-dir	Pfad	aktuelles Verzeichnis	Verzeichnis für die heruntergeladene OutputFile.
–	--no-download	Markieren	aus	Automatischen OutputFile -Download überspringen.
–	--all-fields	Markieren	aus	Gibt die vollständige API-Nutzlast zurück.

Beispiele

uip or jobs get b2c3d4e5-0000-0000-0000-000000000001

# Skip the output-file download (useful in read-only containers)
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 --no-download

# Extract just output arguments
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.OutputArguments'

Datenform (--output json)

{
  "Code": "JobGet",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "ReleaseName": "InvoiceProcessing",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:32:11Z",
    "InputArguments": "{\"invoicePath\":\"/data/inv.pdf\"}",
    "OutputArguments": "{\"result\":\"Processed\"}",
    "HostMachineName": "prod-worker-01",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

UIP oder Auftragsstart

Starten Sie einen oder mehrere Aufträge für einen Prozess. <process-key> ist die von uip or processes list zurückgegebene GUID (nicht packages list). Der Ordner ist optional – wenn weder --folder-path noch --folder-key angegeben sind, wird er aus dem Prozess abgeleitet.

Verwenden Sie uip or packages entry-points um Eingabe-/Ausgabeargumentschemas für eine Paketversion anzuzeigen, bevor Sie beginnen.

Argumente

Name	Erforderlich	Zweck
<process-key>	ja	Prozess-(Release-)Schlüssel (GUID) von uip or processes list.

Optionen

Identität und Mandant

Short	Long	Wert	Standard	Beschreibung
–	--folder-path	Pfad	abgeleitet	Ordnerpfad; aus dem Prozess abgeleitet, wenn sie weggelassen werden.
–	--folder-key	GUID	abgeleitet	Ordnerschlüssel; aus dem Prozess abgeleitet, wenn sie weggelassen werden.

Ausführungsstrategie

Short	Long	Wert	Standard	Beschreibung
–	--strategy	ENUM	ModernJobsCount	ModernJobsCount, All, Specific, JobsCount.
–	--jobs-count	Nummer	1	Wie viele Aufträge erstellt werden sollen (für anzahlbasierte Strategien).
–	--runtime-type	ENUM	Ordnerkonfiguration	Unattended, Headless, Serverless, NonProduction, Development, TestAutomation.
–	--job-priority	ENUM	–	Low, Normal, High.
–	--reference	text	–	Freiform-Referenzzeichenfolge, die für den Auftrag gespeichert wurde.
–	--run-as-me	Markieren	aus	Wird unter der Identität des Aufrufers ausgeführt.
–	--healing-agent	Markieren	aus	Enable Healing Agent (Autopilot for Robots) for this run, to recover from selector failures and similar runtime errors. Tenant-level Autopilot must already be enabled.
–	--user-keys	CSV	–	Benutzer-GUIDs, die ausgeführt werden sollen (aufgelöst für Non-Attended Robots).
–	--machine-keys	CSV	–	Maschinen-GUIDs für das Ziel.

Eingabe und Anhänge

Short	Long	Wert	Standard	Beschreibung
–	--input-arguments	JSON	–	Inline-JSON-Nutzlast. Wird automatisch für InputFile über 10.000 Zeichen abgeladen. Sich gegenseitig mit --input-file ausschließen.
–	--input-file	Pfad	–	Laden Sie eine Datei als InputFile des Auftrags hoch. Sich gegenseitig mit --input-arguments ausschließen.
–	--attachment	[name=]path	–	Laden Sie eine Datei hoch und hängen Sie sie an. Wiederholbar. --attachment ./doc.pdf automatische Namen aus dem Dateinamen; --attachment invoice=./report.pdf legt einen expliziten Namen fest.
–	--attachment-id	GUID	–	Hängen Sie einen vorhandenen Anhang nach ID an. Wiederholbar. IDs mit attachments list --job-key finden.
–	--environment-variables	text	–	Environment variables as newline-separated KEY=VALUE pairs (not JSON). Validated before submission.

Warten auf Abschluss

Short	Long	Wert	Standard	Beschreibung
–	--wait-for-completion	Markieren	aus	Abfragen, bis der Auftrag Successful, Faulted oder Stopped erreicht.
–	--timeout	Sekunden	300	Max. Wartezeit (erfordert --wait-for-completion).
–	--poll-interval	Sekunden	5	Abrufintervall (erfordert --wait-for-completion).
–	--output-dir	Pfad	aktuelles Verzeichnis	Wo OutputFile gespeichert werden soll (erfordert --wait-for-completion).
–	--no-download	Markieren	aus	OutputFile -Download überspringen (erfordert --wait-for-completion).

Hinweis:

--user-keys löst jede Benutzer-GUID für ihren Unattended-Roboter im Zielordner auf. Robotertypen Attended und AttendedStudioWeb werden herausgefiltert – CLI-gestartete Aufträge benötigen Unattended-Roboter. Wenn keine Unattended-Roboter für die Benutzer in diesem Ordner vorhanden sind, schlägt der Befehl fehl.

Beispiele

# Minimal — start one job for a process
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001

# Start with input arguments and wait for completion
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-arguments '{"invoicePath":"/data/inv.pdf"}' \
    --wait-for-completion --timeout 600

# Upload a file as input and attach a supporting document
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-file ./payload.json \
    --attachment invoice=./report.pdf

Datenform (--output json)

Ohne --wait-for-completion:

{
  "Code": "JobStarted",
  "Data": {
    "Jobs": [
      {
        "Key": "b2c3d4e5-0000-0000-0000-000000000099",
        "State": "Pending",
        "ProcessName": "InvoiceProcessing",
        "Source": "Manual",
        "Type": "Unattended",
        "Priority": "Normal",
        "Machine": "",
        "StartTime": "",
        "EndTime": "",
        "CreationTime": "2025-04-15T10:29:55Z"
      }
    ]
  }
}

Mit --wait-for-completion hat Code den Status JobCompleted (oder JobFaulted bei einem Fehler) und Data hat die gleiche Form wie jobs get plus ein Duration -Feld. Wenn der Auftrag fehlgeschlagen ist, wird der Prozess mit Code 1 beendet.

Verbspezifische Exit-Code-Überschreibungen

• --wait-for-completion + Auftrag endet in Faulted: 1 wird beendet, obwohl der Befehl das Ergebnis beobachten konnte.
• --wait-for-completion + Timeout erreicht: 1 wird mit dem aktuellen Auftragsschlüssel in Instructions beendet, sodass Sie mit jobs get abfragen können.

UIP oder Aufträge werden angehalten

Einen oder mehrere laufende oder ausstehende Aufträge anhalten Bei einem einzelnen Schlüssel berücksichtigt --strategy (SoftStop oder Kill). Bei mehreren Schlüsseln wird das Anhalten (Kill) immer über die Massen-API erzwungen – --strategy wird in diesem Fall ignoriert. Kein Ordnerkontext erforderlich; aufgelöst vom ersten Auftragsschlüssel.

Argumente

Name	Erforderlich	Zweck
<job-keys...>	ja	Mindestens ein Auftragsschlüssel (GUIDs).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--strategy	ENUM	SoftStop	SoftStop (anständige) oder Kill (sofort). Gilt nur für Anhalten mit einer Taste.

Beispiele

uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001
uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001 --strategy Kill
uip or jobs stop key-1 key-2 key-3   # bulk force-stop

Datenform (--output json)

Einzelner Schlüssel:

{
  "Code": "JobStopped",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "Strategy": "SoftStop",
    "Status": "Stop requested"
  }
}

Mehrere Schlüssel geben Code: "JobsStopped" mit JobKeys, Strategy: "Kill (force stop)" und einer Status -Zeichenfolge zurück.

UIP oder Auftragsneustart

Erstellen Sie einen neuen Auftrag aus einem fehlerhaften oder angehaltenen Auftrag. Der Ordner wird aus dem Auftragsschlüssel aufgelöst.

Argumente

Name	Erforderlich	Zweck
<job-key>	ja	Auftragsschlüssel (GUID) zum Neustarten.

Optionen

Short	Long	Wert	Standard	Beschreibung

Beispiele

uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001
uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001 --output-filter 'Data.Key'

Datenform (--output json)

{
  "Code": "JobRestarted",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000050",
    "State": "Pending",
    "ProcessName": "InvoiceProcessing",
    "Status": "Restart requested"
  }
}

UIP oder Aufträge fortsetzen

Setzen Sie einen angehaltenen Auftrag fort. Aufträge werden angehalten, wenn sie die Aktivität Suspend in einem Workflow mit langer Ausführungszeit verwenden. Übergeben Sie optional neue --input-arguments , um mit den aktualisierten Daten fortzufahren.

Argumente

Name	Erforderlich	Zweck
<job-key>	ja	Auftragsschlüssel (GUID), der fortgesetzt werden soll.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--input-arguments	JSON	–	Ersatzeingabeargumente.

Beispiele

uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001
uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001 \
    --input-arguments '{"approved":true}'

Datenform (--output json)

{
  "Code": "JobResumed",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Resumed",
    "ProcessName": "ApprovalFlow",
    "Status": "Resume requested"
  }
}

UIP- oder Auftragsprotokolle

Rufen Sie Roboter-Ausführungsprotokolle für einen Auftrag ab. Protokolle werden neueste zuerst zurückgegeben. Verwenden Sie --level , um nach Schweregrad zu filtern. Mit --export werden die Protokolle serverseitig in eine CSV-Datei exportiert und heruntergeladen, wenn sie bereit sind.

Argumente

Name	Erforderlich	Zweck
<job-key>	ja	Auftragsschlüssel (GUID). Wird vor jedem API-Aufruf als UUID validiert.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--level	ENUM	–	Fatal, Error, Warning, Info, Trace.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--export	Markieren	aus	Exportieren Sie in eine CSV-Datei über die serverseitige Export-API.
-o	--output	Pfad	robot-logs-<job-key>.csv	CSV-Ausgabepfad. Nur mit --export.

Beispiele

uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --level Error --limit 100
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --export -o ./run.csv
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 \
    --level Error --output-filter 'Data[].Message'

Datenform (--output json)

Inline-Modus:

{
  "Code": "JobLogs",
  "Data": [
    {
      "Level": "Error",
      "TimeStamp": "2025-04-15T10:31:02Z",
      "Message": "Selector not found: ctrl[name='submit']"
    }
  ]
}

--export gibt Code: "JobLogsExported" mit JobKey, FileName, Size und ExportId aus.

UIP oder Auftragsablaufverfolgungen

Rufen Sie LLMOps-Ausführungsablaufverfolgungen für einen Agent-Auftrag ab – LLM-Interaktionen, Toolaufrufe und Agent-Entscheidungen. Nur für Agent-Typprozesse verfügbar. Der Ordner wird aus dem Auftragsschlüssel aufgelöst.

Argumente

Name	Erforderlich	Zweck
<job-key>	ja	Auftragsschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung

Beispiele

uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001
uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.messages'

Datenform (--output json)

Die unformatierte API-Nutzlast wird unverändert unter Data übergeben:

{
  "Code": "JobTraces",
  "Data": { "...": "raw LlmOps trace payload" }
}

UIP oder Jobs Healing-Data

Laden Sie die Wiederherstellungsdaten des Healing Agent (Autopilot for Robots) als ZIP herunter: Screenshots, UI-Elementdaten und Wiederherstellungsprotokolle. Nur für Aufträge verfügbar, bei denen der Healing Agent aktiv war. Der Befehl löst einen asynchronen Export aus, fragt die Export-API ab, bis sie abgeschlossen ist, und lädt dann die resultierende ZIP-Datei herunter.

Argumente

Name	Erforderlich	Zweck
<job-key>	ja	Auftragsschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--directory-prefix	Präfix	–	Pfadpräfixfilter auf exportierte Dateien angewendet.
-o	--output	Pfad	healing-agent-data-<job-key>.zip	Ausgabe-ZIP-Pfad.

Beispiele

uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    -o ./recovery.zip
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.FileName'

Datenform (--output json)

{
  "Code": "JobHealingData",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "FileName": "healing-agent-data-b2c3d4e5-0000-0000-0000-000000000001.zip",
    "Size": 254318,
    "ExportId": 4711
  }
}

Hinweis:

Der serverseitige Export wird bis zu 30 Mal in 2-Sekunden-Intervallen (60 Sekunden insgesamt) abgefragt. Wenn sie in diesem Fenster nicht abgeschlossen wird, beendet der Befehl 1 mit der Export-ID, sodass Sie es erneut versuchen können.

UIP oder Auftragsverlauf

Rufen Sie den Statusübergangsverlauf für einen Auftrag ab (Pending → Running → Successful/Faulted). Der Ordner wird aus dem Auftragsschlüssel aufgelöst.

Argumente

Name	Erforderlich	Zweck
<job-key>	ja	Auftragsschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung

Beispiele

uip or jobs history b2c3d4e5-0000-0000-0000-000000000001
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data[].{state:State, ts:Timestamp}'
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 --output table

Datenform (--output json)

{
  "Code": "JobHistory",
  "Data": [
    { "State": "Pending", "Timestamp": "2025-04-15T10:29:55Z", "JobId": 1001 },
    { "State": "Running", "Timestamp": "2025-04-15T10:30:00Z", "JobId": 1001 },
    { "State": "Successful", "Timestamp": "2025-04-15T10:32:11Z", "JobId": 1001 }
  ]
}

Exitcodes

Siehe Austrittscodes für den gemeinsamen Vertrag. Verbspezifische Überschreibungen:

• jobs start --wait-for-completion beendet 1 wenn der beobachtete Auftrag Faulted endet oder die Wartezeit abgelaufen ist.
• jobs healing-data beendet 1 wenn der serverseitige Export nicht innerhalb von ~60 Sekunden abgeschlossen ist.

Zugehörige Befehle

• uip or processes – Verwalten Sie die Prozess-(Release-)Bindungen, auf die jobs start abzielt.
• uip or packages – insbesondere packages entry-points zum Erkennen von Eingabe-/Ausgabeargumentschemata.
• uip or attachments – Auftragsanhänge auflisten und herunterladen.
• uip or users – lösen Benutzernamen in Schlüssel für --user-keys auf.
• uip or machines – Lösen Sie Maschinennamen in Schlüssel für --machine-keys auf.

Siehe auch

• Globale Optionen – --output, --output-filter, --log-level, --log-file.
• Sitzungen – wie Mandanten- und Ordnerkontext aufgelöst werden.
• Ihre erste Pipeline – eine End-to-End-Anleitung mit jobs start --wait-for-completion.