UiPath CLI - uip or processes

uipath-cli

latest

false

UiPath CLI user guide

uip or processes

Syntax and options for `uip or processes`, which manages the folder bindings of packages to runnable processes in Orchestrator.

uip or processes manages the runnable bindings of packages to folders — what Orchestrator internally calls Releases. A process is what uip or jobs start targets; a package is the underlying .nupkg artifact (see uip or packages).

Synopsis

uip or processes <verb> [options]
uip or processes <verb> [options]

Verbs

Verb	Purpose
`list`	List processes in a folder, or across every folder in the tenant.
`get`	Fetch one process by key, including argument schemas and retention.
`resources`	List package resources (queues, assets, buckets, connections) required by a process.
`version-history`	List the chronological package-version history for a process.
`create`	Bind a package to a folder as a new process.
`update-version`	Bump one or more processes to the latest (or a specific) package version.
`update` (alias `edit`)	Update process settings (PATCH semantics on selected fields).
`delete`	Delete a process binding by key (does not delete the package).
`rollback`	Roll a process back to its previous package version.

uip or processes list

List processes in a folder (--folder-path or --folder-key), or across every folder in the tenant with --all-folders. Returns the process key (GUID), name, version, folder, and retention settings.

Options

Short	Long	Value	Default	Description
—	`--folder-path`	path	—	Target folder by path.
—	`--folder-key`	GUID	—	Target folder by key.
—	`--all-folders`	flag	off	Tenant-wide listing. Mutually exclusive with `--folder-path`/`--folder-key`.
`-n`	`--name`	text	—	Contains-match on process name.
—	`--process-type`	enum	—	`Process`, `Agent`, `Flow`, `TestAutomationProcess`, `WebApp`, `Api`, `MCPServer`, `BusinessRules`, `CaseManagement`, `Function`.
—	`--all-fields`	flag	off	Return the full API payload.
`-l`	`--limit`	number	`50`	Page size.
—	`--offset`	number	`0`	Skip count.
—	`--sort-by`	field	`Id desc`	OData sort.

Examples

uip or processes list --folder-path "Shared"
uip or processes list --folder-path "Shared" --process-type Agent
uip or processes list --limit 50 --folder-path "Shared" \
    --output-filter '[].{key:Key, name:Name, v:ProcessVersion}'

# Tenant-wide audit across every folder
uip or processes list --all-folders --name "Invoice"
uip or processes list --folder-path "Shared"
uip or processes list --folder-path "Shared" --process-type Agent
uip or processes list --limit 50 --folder-path "Shared" \
    --output-filter '[].{key:Key, name:Name, v:ProcessVersion}'

# Tenant-wide audit across every folder
uip or processes list --all-folders --name "Invoice"

Data shape (--output json)

{
  "Code": "ProcessList",
  "Data": [
    {
      "Key": "c3d4e5f6-0000-0000-0000-000000000001",
      "Name": "InvoiceProcessing",
      "ProcessKey": "InvoiceProcessing",
      "ProcessVersion": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
      "FolderPath": "Shared",
      "RetentionPeriod": 30,
      "RetentionAction": "Delete"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
{
  "Code": "ProcessList",
  "Data": [
    {
      "Key": "c3d4e5f6-0000-0000-0000-000000000001",
      "Name": "InvoiceProcessing",
      "ProcessKey": "InvoiceProcessing",
      "ProcessVersion": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
      "FolderPath": "Shared",
      "RetentionPeriod": 30,
      "RetentionAction": "Delete"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

FolderId is added to each row only when --all-folders is used.

uip or processes get

Fetch one process by GUID key. Returns version, entry point, input/output argument schemas, process type, and configuration. The key resolves tenant-wide by default. Pass --folder-path or --folder-key to scope the lookup to one folder, which an identity with access to a single folder only (such as an external app) requires.

Arguments

Name	Required	Purpose
`<process-key>`	yes	Process key (GUID). Find it with `processes list`.

Options

Short	Long	Value	Default	Description
—	`--folder-path`	path	—	Scope the lookup to this folder instead of resolving the key tenant-wide.
—	`--folder-key`	GUID	—	Scope the lookup to this folder instead of resolving the key tenant-wide.
—	`--all-fields`	flag	off	Return the full API payload.

Examples

uip or processes get c3d4e5f6-0000-0000-0000-000000000001
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'InputArguments'
uip or processes get c3d4e5f6-0000-0000-0000-000000000001
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'InputArguments'

Data shape (--output json)

{
  "Code": "ProcessGet",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "Processes vendor invoices",
    "IsLatestVersion": true,
    "ProcessType": "Process",
    "EntryPointPath": "Main.xaml",
    "InputArguments": "{\"invoicePath\":\"String\"}",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "AutoUpdate": false,
    "TargetFramework": "Windows",
    "JobPriority": "Normal",
    "SpecificPriorityValue": 50,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete",
    "StaleRetentionPeriod": 0,
    "StaleRetentionAction": "None",
    "HiddenForAttendedUser": false,
    "AutoCreateConnectedTriggers": false
  }
}
{
  "Code": "ProcessGet",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "Processes vendor invoices",
    "IsLatestVersion": true,
    "ProcessType": "Process",
    "EntryPointPath": "Main.xaml",
    "InputArguments": "{\"invoicePath\":\"String\"}",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "AutoUpdate": false,
    "TargetFramework": "Windows",
    "JobPriority": "Normal",
    "SpecificPriorityValue": 50,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete",
    "StaleRetentionPeriod": 0,
    "StaleRetentionAction": "None",
    "HiddenForAttendedUser": false,
    "AutoCreateConnectedTriggers": false
  }
}

uip or processes resources

List package resources — queues, assets, buckets, connections, and other package requirements — referenced by a process. Resolves the process's folder automatically; no folder flag needed.

ResourceName, FolderPath, and ResourceId report what the package declares. When the process rebinds a resource to a different target, IsOverwritten is true and the Overwrite* fields describe the target the process binds to:

Field	Description
`IsOverwritten`	`true` when the process rebinds the resource; `false` otherwise.
`OverwriteName`	Display name of the target resource. Empty when the resource is not rebound.
`OverwriteEntityId`	Orchestrator ID of the target resource. Empty when the resource is not rebound.
`OverwriteFolderId`	ID of the folder that holds the target resource. `null` when the resource is not rebound.
`OverwriteProperties`	Property name/value pairs that define the target, for example `name` and `folderPath`. Keys are returned exactly as Orchestrator stores them. `{}` when the resource is not rebound.

With --all-fields, each row carries the raw API resource plus an Overwrite object (null when the resource is not rebound).

Arguments

Name	Required	Purpose
`<process-key>`	yes	Process key (GUID). Find it with `processes list`.

Options

Short	Long	Value	Default	Description
—	`--all-fields`	flag	off	Return the full API payload instead of the curated summary.

Examples

uip or processes resources c3d4e5f6-0000-0000-0000-000000000001
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001 --all-fields

Data shape (--output json)

{
  "Code": "ProcessResources",
  "Data": [
    {
      "ResourceType": "Queue",
      "ResourceName": "InvoiceQueue",
      "FolderPath": "Shared",
      "ValidationResult": "Success",
      "ValidationError": "",
      "IsOverwritable": true,
      "ResourceKey": "InvoiceQueue",
      "ResourceId": "123456",
      "Id": 0,
      "IsOverwritten": false,
      "OverwriteName": "",
      "OverwriteEntityId": "",
      "OverwriteFolderId": null,
      "OverwriteProperties": {}
    }
  ]
}
{
  "Code": "ProcessResources",
  "Data": [
    {
      "ResourceType": "Queue",
      "ResourceName": "InvoiceQueue",
      "FolderPath": "Shared",
      "ValidationResult": "Success",
      "ValidationError": "",
      "IsOverwritable": true,
      "ResourceKey": "InvoiceQueue",
      "ResourceId": "123456",
      "Id": 0,
      "IsOverwritten": false,
      "OverwriteName": "",
      "OverwriteEntityId": "",
      "OverwriteFolderId": null,
      "OverwriteProperties": {}
    }
  ]
}

A resource that the process rebinds to a different folder:

{
  "Code": "ProcessResources",
  "Data": [
    {
      "ResourceType": "App",
      "ResourceName": "ApprovalApp",
      "FolderPath": "Dev/Apps",
      "ValidationResult": "Success",
      "ValidationError": "",
      "IsOverwritable": true,
      "ResourceKey": "Dev/Apps.ApprovalApp",
      "ResourceId": "555001",
      "Id": 0,
      "IsOverwritten": true,
      "OverwriteName": "ApprovalApp",
      "OverwriteEntityId": "777002",
      "OverwriteFolderId": 4412,
      "OverwriteProperties": {
        "name": "ApprovalApp",
        "folderPath": "Prod/Apps"
      }
    }
  ]
}
{
  "Code": "ProcessResources",
  "Data": [
    {
      "ResourceType": "App",
      "ResourceName": "ApprovalApp",
      "FolderPath": "Dev/Apps",
      "ValidationResult": "Success",
      "ValidationError": "",
      "IsOverwritable": true,
      "ResourceKey": "Dev/Apps.ApprovalApp",
      "ResourceId": "555001",
      "Id": 0,
      "IsOverwritten": true,
      "OverwriteName": "ApprovalApp",
      "OverwriteEntityId": "777002",
      "OverwriteFolderId": 4412,
      "OverwriteProperties": {
        "name": "ApprovalApp",
        "folderPath": "Prod/Apps"
      }
    }
  ]
}

uip or processes version-history

List the chronological package-version history associated with a process. Folder is optional — if not provided, it is inferred from the process key.

Arguments

Name	Required	Purpose
`<process-key>`	yes	Process key (GUID).

Options

Short	Long	Value	Default	Description
—	`--folder-path`	path	inferred	Skip auto-detection and use this folder.
—	`--folder-key`	GUID	inferred	Skip auto-detection and use this folder.
—	`--all-fields`	flag	off	Return the full API payload instead of the curated summary.

Examples

uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001
uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001

Data shape (--output json)

{
  "Code": "ProcessVersionHistory",
  "Data": [
    {
      "Version": "1.0.0",
      "CreatedAt": "2024-01-10T08:30:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1001
    },
    {
      "Version": "1.0.2",
      "CreatedAt": "2024-01-15T09:45:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1002
    }
  ]
}
{
  "Code": "ProcessVersionHistory",
  "Data": [
    {
      "Version": "1.0.0",
      "CreatedAt": "2024-01-10T08:30:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1001
    },
    {
      "Version": "1.0.2",
      "CreatedAt": "2024-01-15T09:45:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1002
    }
  ]
}

uip or processes create

Bind a package to a folder as a process. Requires --folder-path or --folder-key and three required package options. Use uip or packages list for the package key and uip or packages versions for available versions.

Job retention defaults to Delete after 30 days. To archive jobs instead, pass --retention-action Archive with --retention-bucket <bucket-key>. To archive stale jobs, pass --stale-retention-action Archive with --stale-retention-period <days> and --stale-retention-bucket <bucket-key>.

Options

Required

Short	Long	Value	Default	Description
—	`--name`	text	—	Process name inside the folder.
—	`--package-key`	text	—	Package key (the `PackageId` from `packages list`).
—	`--package-version`	version	—	Package version (for example, `1.0.0`).

Identity and scope

Short	Long	Value	Default	Description
—	`--folder-path`	path	—	Target folder by path.
—	`--folder-key`	GUID	—	Target folder by key.

Process settings

Short	Long	Value	Default	Description
—	`--description`	text	—	Process description.
—	`--entry-point`	path	—	Entry-point workflow path (for multi-entry-point packages).
—	`--input-arguments`	JSON	—	Default input arguments as JSON.
—	`--job-priority`	enum	—	`Low`, `Normal`, `High`. Mutually exclusive with `--specific-priority`.
—	`--specific-priority`	1–100	—	Numeric priority. Mutually exclusive with `--job-priority`.
—	`--robot-size`	enum	—	Cloud robot size: `Small`, `Standard`, `Medium`, `Large`.
—	`--tags`	CSV	—	Comma-separated tag names.
—	`--environment-variables`	text	—	Environment variables as newline-separated `KEY=VALUE` pairs (not JSON), e.g. `$'FOO=bar\nBAZ=qux'`.
—	`--auto-update` / `--no-auto-update`	flag	—	Enable/disable auto-update to latest package version.
—	`--hidden-for-attended` / `--visible-for-attended`	flag	—	Hide or show to attended users. Mutually exclusive.
—	`--auto-create-triggers` / `--no-auto-create-triggers`	flag	—	Auto-create connected triggers on deploy.

Retention

Short	Long	Value	Default	Description
—	`--retention-period`	days (1–180)	`30`	Job retention period.
—	`--retention-action`	enum	`Delete`	`Delete`, `Archive`, or `None`. `Archive` requires `--retention-bucket`.
—	`--retention-bucket`	bucket key (GUID)	—	Storage bucket key for archived jobs. Required when `--retention-action` is `Archive`, and rejected for `Delete` or `None`. The bucket must be in, or shared to, the process folder. Get the key from `uip or buckets list`.
—	`--stale-retention-period`	days	`180` for `Delete`/`None`	Stale-job retention period. Requires `--stale-retention-action`. Required when the stale action is `Archive`.
—	`--stale-retention-action`	enum	—	`Delete`, `Archive`, or `None`. `Archive` requires `--stale-retention-bucket`.
—	`--stale-retention-bucket`	bucket key (GUID)	—	Storage bucket key for archived stale jobs. Required when `--stale-retention-action` is `Archive`. The bucket must be in, or shared to, the process folder. Get the key from `uip or buckets list`.

Examples

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" \
    --package-key InvoiceProcessing --package-version 1.0.2

uip or processes create --folder-path "Production/EU" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --job-priority High --auto-update --tags "finance,eu"

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --output-filter 'Key'
uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" \
    --package-key InvoiceProcessing --package-version 1.0.2

uip or processes create --folder-path "Production/EU" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --job-priority High --auto-update --tags "finance,eu"

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --output-filter 'Key'

Data shape (--output json)

{
  "Code": "ProcessCreated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000010",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "",
    "IsLatestVersion": true,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete"
  }
}
{
  "Code": "ProcessCreated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000010",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "",
    "IsLatestVersion": true,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete"
  }
}

uip or processes update-version

Update one or more processes to the latest package version, or to a specific version with --package-version. Folder is optional — if not provided it is inferred from the first process key.

One key + no --package-version → update to latest (single API call).
One key + --package-version → update to that version (single API call).
Multiple keys + no --package-version → bulk update-to-latest.
Multiple keys + --package-version → rejected (validation error).

Running jobs are unaffected; only new jobs use the updated version.

Arguments

Name	Required	Purpose
`<process-keys...>`	yes	One or more process keys (GUIDs).

Options

Short	Long	Value	Default	Description
—	`--folder-path`	path	inferred	Skip auto-detection and use this folder.
—	`--folder-key`	GUID	inferred	Skip auto-detection and use this folder.
—	`--package-version`	version	—	Specific version. Only valid with a single key.

Examples

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001 \
    --package-version 1.0.3

uip or processes update-version \
    c3d4e5f6-0000-0000-0000-000000000001 \
    c3d4e5f6-0000-0000-0000-000000000002 \
    --output-filter 'Version'
uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001 \
    --package-version 1.0.3

uip or processes update-version \
    c3d4e5f6-0000-0000-0000-000000000001 \
    c3d4e5f6-0000-0000-0000-000000000002 \
    --output-filter 'Version'

Data shape (--output json)

Single-key:

{
  "Code": "ProcessVersionUpdated",
  "Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}
{
  "Code": "ProcessVersionUpdated",
  "Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}

Bulk returns Code: "ProcessVersionsUpdated" with ProcessKeys, Version, and a Result object echoed from the API.

uip or processes update

Update process settings by key. Reads current values, applies the PATCH fields provided, and saves. Only provided fields are changed; fields omitted on the CLI are preserved from the current state. The key resolves tenant-wide by default. Pass --folder-path or --folder-key to scope the lookup to one folder, which an identity with access to a single folder only (such as an external app) requires.

edit is a registered alias for this verb — uip or processes edit works identically to uip or processes update.

Arguments

Name	Required	Purpose
`<process-key>`	yes	Process key (GUID).

Options

Same fields as processes create except for the three required package options and --tags. Mutual-exclusion and validation rules match create (--job-priority vs --specific-priority, --hidden-for-attended vs --visible-for-attended). Archive retention needs a storage bucket: while the action stays Archive, the current bucket is kept, and when the action changes to Delete or None, the bucket is cleared.

Short	Long	Value	Default	Description
—	`--folder-path`	path	—	Scope the key lookup to this folder instead of resolving it tenant-wide.
—	`--folder-key`	GUID	—	Scope the key lookup to this folder instead of resolving it tenant-wide.
`-n`	`--name`	text	—	New display name.
`-d`	`--description`	text	—	New description.
—	`--entry-point`	path	—	New entry-point path.
—	`--input-arguments`	JSON	—	Default input arguments.
—	`--environment-variables`	text	—	Newline-separated `KEY=VALUE` pairs (not JSON). Pass `''` to clear them.
—	`--job-priority`	enum	—	`Low`, `Normal`, `High`.
—	`--specific-priority`	1–100	—	Numeric priority.
—	`--robot-size`	enum	—	Cloud robot size: `Small`, `Standard`, `Medium`, `Large`.
—	`--auto-update` / `--no-auto-update`	flag	—	Toggle auto-update.
—	`--hidden-for-attended` / `--visible-for-attended`	flag	—	Attended visibility.
—	`--auto-create-triggers` / `--no-auto-create-triggers`	flag	—	Connected-trigger auto-create.
—	`--healing-agent` / `--no-healing-agent`	flag	—	Enable or disable Healing Agent (Autopilot for Robots) for this process. Future jobs use it by default once enabled; tenant-level Autopilot must already be on.
—	`--retention-period`	days (1–180)	—	Job retention period.
—	`--retention-action`	enum	—	`Delete`, `Archive`, `None`. Switching to `Archive` requires `--retention-bucket` unless the process already archives.
—	`--retention-bucket`	bucket key (GUID)	—	Storage bucket key for archived jobs. Omit to keep the current bucket. The bucket must be in, or shared to, the process folder. Get the key from `uip or buckets list`.
—	`--stale-retention-period`	days	—	Stale-job retention period. Omit to keep the current period. When no period is stored, `Delete`/`None` use `180` and `Archive` requires this option.
—	`--stale-retention-action`	enum	—	`Delete`, `Archive`, `None`. `Archive` requires `--stale-retention-bucket`.
—	`--stale-retention-bucket`	bucket key (GUID)	—	Storage bucket key for archived stale jobs. Omit to keep the current bucket. The bucket must be in, or shared to, the process folder. Get the key from `uip or buckets list`.

Examples

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --description "Monthly invoice batch"

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --job-priority High --retention-period 60

# Archive completed jobs to a storage bucket after 60 days
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --retention-action Archive --retention-period 60 \
    --retention-bucket b1b2c3d4-0000-0000-0000-000000000001

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --auto-update --output-filter 'Status'
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --description "Monthly invoice batch"

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --job-priority High --retention-period 60

# Archive completed jobs to a storage bucket after 60 days
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --retention-action Archive --retention-period 60 \
    --retention-bucket b1b2c3d4-0000-0000-0000-000000000001

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --auto-update --output-filter 'Status'

Data shape (--output json)

{
  "Code": "ProcessUpdated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "Status": "Updated successfully"
  }
}
{
  "Code": "ProcessUpdated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "Status": "Updated successfully"
  }
}

uip or processes delete

Delete a process binding by key. This removes the release binding from its folder — it does not delete the underlying package.

Arguments

Name	Required	Purpose
`<process-key>`	yes	Process key (GUID). Find it with `processes list`.

Options

Short	Long	Value	Default	Description
`-y`	`--yes`	flag	—	Required. Confirms this irreversible operation — the CLI never prompts.

Examples

uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes
uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes

Data shape (--output json)

{
  "Code": "ProcessDeleted",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "Status": "Deleted successfully"
  }
}
{
  "Code": "ProcessDeleted",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "Status": "Deleted successfully"
  }
}

uip or processes rollback

Roll a process back to its previous package version. Folder is optional — if not provided it is inferred from the process key.

Arguments

Name	Required	Purpose
`<process-key>`	yes	Process key (GUID).

Options

Short	Long	Value	Default	Description
—	`--folder-path`	path	inferred	Skip auto-detection.
—	`--folder-key`	GUID	inferred	Skip auto-detection.

Examples

uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --folder-path "Shared"
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Status'
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --folder-path "Shared"
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Status'

Data shape (--output json)

{
  "Code": "ProcessRolledBack",
  "Data": {
    "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "Status": "Rolled back to previous version"
  }
}
{
  "Code": "ProcessRolledBack",
  "Data": {
    "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "Status": "Rolled back to previous version"
  }
}

Exit codes

See Exit codes. No verb-specific overrides beyond the standard validation errors.

uip or packages — find package keys (packages list), versions (packages versions), and entry points (packages entry-points) before calling processes create.
uip or jobs — especially jobs start, which takes a process key.
uip or folders — create or locate the target folder before binding.

Synopsis​

Verbs​

uip or processes list​

Options​

Examples​

Data shape (--output json)​

uip or processes get​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or processes resources​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or processes version-history​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or processes create​

Options​

Required​

Identity and scope​

Process settings​

Retention​

Examples​

Data shape (--output json)​

uip or processes update-version​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or processes update​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or processes delete​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or processes rollback​

Arguments​

Options​

Examples​

Data shape (--output json)​

Exit codes​

Related commands​

See also​

Was this page helpful?

Synopsis

Verbs

uip or processes list

Options

Examples

Data shape (--output json)

uip or processes get

Arguments

Options

Examples

Data shape (--output json)

uip or processes resources

Arguments

Options

Examples

Data shape (--output json)

uip or processes version-history

Arguments

Options

Examples

Data shape (--output json)

uip or processes create

Options

Required

Identity and scope

Process settings

Retention

Examples

Data shape (--output json)

uip or processes update-version

Arguments

Options

Examples

Data shape (--output json)

uip or processes update

Arguments

Options

Examples

Data shape (--output json)

uip or processes delete

Arguments

Options

Examples

Data shape (--output json)

uip or processes rollback

Arguments

Options

Examples

Data shape (--output json)

Exit codes

Related commands

See also