Ausführung des UIP-API-Workflows

Syntax und Optionen für „uip api-workflow run“, der eine API Workflow JSON-Datei lokal mithilfe des gebündelten Serverless Workflow Executor ausführt.

uip api-workflow run führt eine API Workflow-JSON-Datei lokal mithilfe des gebündelten Serverless Workflow Executor aus. Eingabeargumente werden als JSON übergeben. Standardmäßig lädt der Executor UiPath-Anmeldeinformationen aus der uip login -Sitzung, damit der Workflow Connector und Cloud-gestützte Dienste erreichen kann; Übergeben Sie --no-auth , um das Laden der Anmeldeinformationen zu überspringen und in einem reinen lokalen Modus auszuführen.

Zusammenfassung

uip api-workflow run <file> [options]

• <file> – Der Pfad zur Workflow-JSON-Datei.

Optionen

Markieren	Beschreibung
-i, --input-arguments <json>	Geben Sie Argumente als JSON-Zeichenfolge ein, z. B. '{"name": "World"}'.
--input-file <name=path>	Upload a local file and pass it as the file (JobAttachment) input <name>. Repeatable for multiple files. Needs a signed-in session.
--output-dir <dir>	Download every file (JobAttachment) reference in the workflow output into <dir>; each downloaded reference gains a LocalPath. Needs a signed-in session.
--folder-key <guid>	Orchestrator folder key for the attachments this run creates (uploaded inputs and files written by the File to Base64 / Base64 to File activities).
--no-auth	Skip credential loading. The workflow runs in a local-only mode with no access to connectors or cloud-backed services (also disables --input-file/--output-dir).

Beispiele

# Run with an inline input object
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}'

# Run without loading credentials (offline / local-only)
uip api-workflow run ./workflow.json --no-auth

# Extract just the output payload
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}' \
    --output-filter 'Data.Output'

# Upload a local file as a file (JobAttachment) input, and download any file
# outputs the workflow produces
uip api-workflow run ./workflow.json \
    --input-file document=./invoice.pdf \
    --output-dir ./out

Datenform (--output json)

{
  "Code": "WorkflowRun",
  "Data": {
    "Status": "Completed",
    "Output": {
      "greeting": "Hello, World!"
    }
  }
}

Status spiegelt den Endstatus des Executors wider (Completed, Faulted usw.). Eine fehlerhafte Ausführung beendet gemäß den Standard- Exit-Codes einen anderen Wert als Null.

When the workflow output includes a file (JobAttachment) reference and --output-dir is set, the shape instead centers on the downloaded file:

{
  "Code": "WorkflowRun",
  "Data": {
    "Encoded": {
      "Id": "6f1c0d2e-8a1b-4c3d-9e0f-123456789abc",
      "FullName": "invoice.base64",
      "MimeType": "text/plain",
      "LocalPath": "/abs/path/out/invoice.base64"
    }
  }
}

LocalPath is only populated when --output-dir is set — without it, the reference is returned without a local file.

Zugehörig

• uip api-workflow build – kompilieren Sie das Projekt, bevor Sie es ausführen.
• uip api-workflow pack – Verpacken Sie einen validierten Workflow für die Veröffentlichung.

Siehe auch

• Übersicht über das API-Workflow-Tool
• Globale Optionen
• Exitcodes
• uip login – Anmeldeinformationen, die von run geladen werden, es sei denn, --no-auth ist festgelegt.