uip maestro flow process and uip maestro flow processes

Syntax and options for `uip maestro flow process` and `uip maestro flow processes`, covering per-folder and tenant-wide published Flow process operations.

Once a Flow package is published to Orchestrator it becomes a process. This page covers two related command groups:

• uip maestro flow process — per-folder operations on a single process definition (list in a folder, get its schema, run it).
• uip maestro flow processes (plural) — tenant-wide summaries and per-process incident lookup.

Synopsis

# Singular — per-folder, operational
uip maestro flow process list (-f <folder-key> | --folder-path <path>) [--filter <odata>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list [--folder-key <key>] [-l, --limit <number>] [--offset <number>] [--status <status>]
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <process-key> --folder-key <key>

All subcommands require uip login and honor global options. Exit codes follow the standard contract.

---

uip maestro flow process list

List available Flow processes (releases) in a specific folder.

Options

Option	Required	Description
-f, --folder-key <key>	one of --folder-key or --folder-path	Folder key (GUID).
--folder-path <path>	one of --folder-key or --folder-path	Folder path, e.g. Shared/Invoices. When you pass both options, they must refer to the same folder.
--filter <odata>	no	Additional OData filter applied server-side.
--login-validity <minutes>	no	Token-refresh threshold (default 10).

Passing neither --folder-key nor --folder-path fails with exit code 3.

Data shape (--output json)

{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "releaseActive": "Yes",
      "releaseLatest": "Yes"
    }
  ]
}

releaseActive and releaseLatest reflect the Orchestrator release state: whether the release is marked active, and whether it is the highest version. They do not indicate whether the process is deployed or runnable.

---

uip maestro flow process get

Fetch the entry-point schema (input/output JSON schemas) for a Flow process. Use the result to build a valid --inputs payload for process run.

Arguments

• <process-key> (required) — process key, e.g. MyFlow.flow.Flow:1.0.0 or <package-id>:<version>.
• <feed-id> (required) — feed ID (from the list output).

Options

• -f, --folder-key <key> (required)
• --login-validity

Data shape

{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema and OutputSchema are re-stringified JSON; parse them as JSON Schema to drive input construction.

---

uip maestro flow process run

Start a Flow job for a published process.

Arguments

• <process-key> (required) — process key (e.g. MyFlow.flow.Flow:1.0.0).
• <folder-key> (required) — folder key (GUID).

Options

Option	Description
-i, --inputs <json>	Inputs as a JSON string or @path/to/file.json. If omitted and stdin is piped, stdin is parsed as inputs.
--release-key <key>	Release key (GUID) — from process list. When omitted, the command looks up the release that matches <process-key> (name and version) in the folder. If no release or more than one release matches, the command fails with Code: "FlowReleaseKeyRequired"; pass the matching releaseKey from process list.
--feed-id <id>	Feed ID for package lookup (optional).
--robot-ids <ids>	Comma-separated robot IDs (integers). Invalid values fail fast.
--attachment <name=path>	Upload a local file to Orchestrator and bind it as a file-type input variable. Repeatable, e.g. --attachment file1=./resume.pdf. Overrides the same variable name if also present in --inputs.
--wait	Block until the job reaches a terminal state instead of returning immediately with Pending.
--timeout <seconds>	Maximum seconds to wait. 0 = no timeout. Default: 1800. Requires --wait.
--poll-interval <seconds>	Seconds between status checks while waiting. Default: 5. Requires --wait.
--validate	Validate inputs against the process schema before running. Performs basic checks only — required fields present and primitive types match. Complex constraints (enums, patterns, references) are not enforced by this pass.
--login-validity <minutes>	Token-refresh threshold (default 10).

Input precedence: --inputs <json> / --inputs @file.json > stdin > empty object {}.

Examples

# Run with inline JSON (the release key is looked up)
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --inputs '{"amount":100}'

# Run a specific release
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Bind a local file to a file-typed input variable
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --attachment file1=./resume.pdf

# Run with inputs from a file
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate

Data shape

{
  "Code": "FlowJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "folderKey": "c3d4e5f6-0000-0000-0000-000000000001"
  }
}

Next step: uip maestro flow job traces <jobKey> --folder-key <folder-key> to stream execution or uip maestro flow job status <jobKey> to poll. With --wait, the command keeps polling after this output until the job reaches a terminal state.

---

uip maestro flow process settings

Get or update a process's runtime settings.

uip maestro flow process settings get

Arguments

• <process-key> (required) — process definition key.

Options

• -f, --folder-key <key> (required)

Data shape

Code: "ProcessSettingsGet", Data is the process settings object.

uip maestro flow process settings set

Arguments

• <process-key> (required)

Options

Option	Description
-f, --folder-key <key>	(required) Folder key (GUID).
--inputs <value>	Settings payload as a JSON string, an @file path, or piped via stdin.

Data shape

Code: "ProcessSettingsSet".

uip maestro flow process variable-tags

Get or update searchability tags on a process's output variables — which variables can be used to filter instances.

uip maestro flow process variable-tags get

Arguments

• <process-key> (required)

Options

• -f, --folder-key <key> (required)

Data shape

Code: "ProcessVariableTagsGet", Data is the process's variableTags map ({} if none are set).

uip maestro flow process variable-tags set

Two mutually exclusive input styles: pass --inputs with a full JSON payload, or use the friendly --variable/--all/--searchable/--tags/--add-tags/--remove-tags flags — combining both fails with an error.

Arguments

• <process-key> (required)

Options

Option	Description
-f, --folder-key <key>	(required) Folder key (GUID).
--variable <name>	Name of a variable (output) to tag. Repeatable, to tag several in one call.
--element-id <id>	Element that owns the variable — disambiguates when the same name appears on multiple elements. Only valid with a single --variable.
--all	Apply the change to every taggable variable.
--searchable <bool>	Mark the variable(s) searchable for instance filtering (true/false).
--tags <csv>	Advanced: replace the variable's current tags outright. Empty value clears them.
--add-tags <csv>	Add tags to the variable's current tags.
--remove-tags <csv>	Remove tags from the variable's current tags.
--inputs <value>	Full variable-tags payload as a JSON string, an @file path, or piped via stdin — an alternative to the flags above.

Data shape

Code: "ProcessVariableTagsSet". With --inputs, Data is the updated process settings. With the flags, Data is { updated, variableTags }.

---

uip maestro flow processes list [--folder-key ] [-l, --limit ] [--offset ] [--status ]

Tenant-wide summary of Flow processes.

Options

Option	Description
--folder-key <key>	Folder key, to scope the summary to one folder.
-l, --limit <number>	Number of items to return (1–10000).
--offset <number>	Number of items to skip (0–1000000). Default: 0.
--status <status>	Filter by process status.

Data shape

{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}

Note:

The exact field set of each process summary is specified by the Maestro runtime and may evolve; run the command once with --output json against a tenant with data to see the fields you will be consuming, and pin @uipath/cli in CI if you parse specific fields.

---

uip maestro flow processes incidents

Get all incidents for a specific Flow process definition (not a single instance).

Arguments

• <process-key> (required) — process definition key.

Options

• --folder-key <key> (required) — folder key to scope the lookup.

Data shape

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

See uip maestro flow incident for the per-incident shape.

uip maestro flow processes diagnose

Correlate a process's summary, incidents, and error codes in one call — a quick triage command.

Arguments

• <process-key> (required) — process definition key.

Options

• --folder-key <key> (required)

Data shape

{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}

uip maestro flow processes error-codes

Get the unique set of error codes seen across a process's incidents.

Arguments

• <process-key> (required)

Options

• --folder-key <key> (required)

Data shape

{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}

See also

• uip maestro flow instance — inspect and steer running executions
• uip maestro flow job — traces and status for a single job
• uip maestro flow incident — incident summaries and details
• Orchestrator jobs, Orchestrator processes
• Flow overview