UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip maestro bpmn incidents

Syntax and options for `uip maestro bpmn incident`, which reads tenant-wide or single-record incidents raised during Maestro BPMN process execution.

uip maestro bpmn incident reads incidents — unhandled errors raised during Maestro process execution — either as tenant-wide summaries or as a single record by ID. The command name is singular (incident) even though the file and sidebar entry say incidents. It's registered under the bpmn branch — there is no bare uip maestro incident.

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

Synopsis

uip maestro bpmn incident summary [--folder-key <key>] [-l <limit>] [--offset <n>] [--process-key <key>] [--status <status>] [--severity <severity>]
uip maestro bpmn incident get <incident-id> -f, --folder-key <key>
uip maestro bpmn incident summary [--folder-key <key>] [-l <limit>] [--offset <n>] [--process-key <key>] [--status <status>] [--severity <severity>]
uip maestro bpmn incident get <incident-id> -f, --folder-key <key>

For incidents scoped to a specific process or instance, use:

uip maestro bpmn incident summary

Get a rollup of incidents across Maestro processes.

Arguments

None.

Options

OptionDescription
--folder-key <key>Folder key. Optional — omit for a tenant-wide rollup.
-l, --limit <number>Number of items to return (1-10000).
--offset <number>Number of items to skip (0-1000000). Default 0.
--process-key <process-key>Filter by process key.
--status <status>Filter by incident status.
--severity <severity>Filter by incident severity.

Data shape (--output json)

{
  "Code": "IncidentSummary",
  "Data": [ /* array of incident summaries */ ]
}
{
  "Code": "IncidentSummary",
  "Data": [ /* array of incident summaries */ ]
}

uip maestro bpmn incident get

Get a single incident by ID.

Arguments

  • <incident-id> (required) — incident ID. URL-encoded automatically.

Options

OptionDescription
-f, --folder-key <key>Folder key. Required.

Data shape

{
  "Code": "IncidentGet",
  "Data": { /* incident details */ }
}
{
  "Code": "IncidentGet",
  "Data": { /* incident details */ }
}

Examples

# Tenant-wide rollup
uip maestro bpmn incident summary

# Filter by status and severity, paginated
uip maestro bpmn incident summary --status Open --severity High --limit 100

# Extract a terse view
uip maestro bpmn incident summary --output-filter "[*].{processKey:processKey,count:incidentCount}"

# Fetch one
uip maestro bpmn incident get "inc_abcdef1234" --folder-key <folder-key>
# Tenant-wide rollup
uip maestro bpmn incident summary

# Filter by status and severity, paginated
uip maestro bpmn incident summary --status Open --severity High --limit 100

# Extract a terse view
uip maestro bpmn incident summary --output-filter "[*].{processKey:processKey,count:incidentCount}"

# Fetch one
uip maestro bpmn incident get "inc_abcdef1234" --folder-key <folder-key>

See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated