uip solution resources

Syntax and options for `uip solution resources`, which manages the Orchestrator and Data Service resources a local solution depends on.

uip solution resources manages the resources — queues, assets, buckets, processes, connections, entities, choice sets, and other Orchestrator and Data Service objects — that a local solution depends on. Every project's resource bindings are aggregated into the solution's own resource list; use this command group to inspect it, add to it, edit it, or re-sync it after editing project bindings.

Observação:

Não deve ser confundido com uip or

uip or provides CRUD over Orchestrator's server-side queues, assets, buckets, etc. on a live tenant. uip solution resources inspects and edits the local solution's declared list of those resources — its own file on disk, not the live tenant. list --source remote and add --source remote do call Orchestrator to look things up, but the result is always written into the local solution.

Resumo

uip solution resources list      [--solution-folder <path>] [--kind <kind>] [--search <term>] [--source <all|local|remote>] [--include-version] [--login-validity <minutes>]
uip solution resources get       <resource-key> [--solution-folder <path>] [--include-dependencies] [--login-validity <minutes>]
uip solution resources add       --source <local|remote> --kind <kind> --name <name> [--type <type>] [--folder-path <path>] [--cloud-key <guid>] [--solution-folder <path>] [--login-validity <minutes>]
uip solution resources remove    <resource-key> [--solution-folder <path>]
uip solution resources edit      <resource-key> --patch <json> [--solution-folder <path>]
uip solution resources refresh   [--solution-folder <path>] [--login-validity <minutes>]

All six verbs take --solution-folder <path> (defaults to the current directory) — none take a positional path argument.

List

List resources in the solution and/or available in Orchestrator. By default (--source all), returns both the resources declared locally and the resources Orchestrator reports for the associated remote tenant; when both are listed, a remote entry matching a local one by Kind:Name (case-insensitive) is deduplicated in favor of the local entry.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Path to the solution root folder.
--kind	text	—	Filter by resource kind (for example Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Any kind the SDK indexes is accepted — this is not a fixed enum.
--search	text	—	Contém correspondência no nome do recurso.
--source	all | local | remote	all	Which side to list.
--include-version	Bandeira	desativada	Also report each resource's deployed version, for kinds that carry one (app, appVersion, package, process). Costs one extra call per resource, so it's off by default.
--login-validity	minutos	10	Minimum minutes before token expiration to trigger a refresh.

Exemplos

# All resources the current solution knows about
uip solution resources list

# Only queues declared locally
uip solution resources list --kind Queue --source local

# Deployed version per folder for classic Apps
uip solution resources list --kind app --source remote --include-version

Formato dos dados (--output json)

{
  "Code": "ResourceList",
  "Data": [
    {
      "Source": "Remote",
      "Key": "0c2b7f04-1d3e-4a55-9f77-2b1a6d9e4c81",
      "Name": "InvoiceQueue",
      "Kind": "queue",
      "Folder": "Shared"
    },
    {
      "Source": "Remote",
      "Key": "a9c9d05f-6d85-41cd-8a54-a479d494bedc",
      "Name": "Validation App",
      "Kind": "app",
      "Folder": "Shared/Validation",
      "FolderKey": "0932a1f4-5cd1-44d4-9f02-cdc92244a6d2",
      "Version": "12.0.0"
    }
  ]
}

Observação:

--source remote (and all) requires an authenticated session with access to the solution's target Orchestrator.

get

Get the configuration of a solution resource by key — the spec, locks, and metadata as the SDK exposes them. If the key isn't in the local solution, falls back to a live Orchestrator/resource-catalog lookup so the command is still useful for resources not yet bound to the solution.

Argumentos

Name	Required	Finalidade
<resource-key>	sim	Solution resource key — a GUID, or a composite key like TestRPA.process.TestRPA:1.0.0 for packages.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Path to the solution root folder.
--include-dependencies	Bandeira	desativada	Also return configurations for every dependency the resource references.
--login-validity	minutos	10	Minimum minutes before token expiration to trigger a refresh.

Exemplos

uip solution resources get fb39bc38-255e-4fea-93c6-7c7eb44d766f

uip solution resources get fb39bc38-255e-4fea-93c6-7c7eb44d766f \
  --solution-folder ./my-solution --include-dependencies

Formato dos dados (--output json)

{
  "Code": "ResourceConfiguration",
  "Data": {
    "key": "fb39bc38-255e-4fea-93c6-7c7eb44d766f",
    "spec": { "name": "RPA Workflow", "type": "Process" },
    "locks": [],
    "apiVersion": "orchestrator.uipath.com/v1",
    "isOverridable": true
  }
}

If the linked live resource has drifted from the local declaration, the response adds liveSpec (the current live spec) alongside the stale spec, and resourceOverwrite.matchingOverwriteConfiguration: false:

{
  "Code": "ResourceConfiguration",
  "Data": {
    "key": "0f8a1c9e-2b47-4d0a-9c31-5e2f6d8a7b10",
    "spec": { "name": "Approval App", "version": "7.0.0" },
    "liveSpec": { "name": "Approval App", "version": "12.0.0" },
    "resourceOverwrite": { "matchingOverwriteConfiguration": false }
  }
}

--include-dependencies returns Code: "ResourceConfigurations" with a resources array instead, each entry adding name, kind, and dependencies.

Adicionar

Add a resource to the solution. --source local creates a virtual stub with no remote lookup; --source remote imports an existing Orchestrator resource. Idempotent: a resource matching the same (kind, name, folder) — or, on the remote path, the same resolved cloud key — is returned unchanged rather than duplicated.

Opções

Long	Valor	Padrão	Description
--source	local | remote	—	Obrigatório. local creates a virtual stub; remote imports from Orchestrator.
--kind	text	—	Required. Resource kind (for example Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Case-insensitive.
--name	text	—	Required. Resource name (max 256 characters; cannot contain / \ : * ? " < > | or control characters).
--type	text	—	Resource subtype (for example Text/Bool/Integer for Asset, a connector type for Connection). Required for kinds the SDK indexes by (kind, type) unless resolvable from a remote match.
--folder-path	Path	—	Orchestrator folder path for remote lookup; disambiguates when more than one remote match exists. Not valid with --source local.
--cloud-key	GUID	—	Skip the remote name search and import this exact resource key. Only valid with --source remote.
--solution-folder	Path	diretório atual	Path to the solution root folder.
--login-validity	minutos	10	Minimum minutes before token expiration to trigger a refresh.

If a remote name search matches more than one resource, the command fails and lists each candidate's folder, type, and key so you can disambiguate with --cloud-key.

Exemplos

# Create a local virtual stub (no remote lookup)
uip solution resources add --source local --kind Queue --name InvoiceQueue

# Import an existing remote queue, disambiguated by folder path
uip solution resources add --source remote --kind Queue --name InvoiceQueue \
  --folder-path Sales/CRM

Formato dos dados (--output json)

{
  "Code": "ResourceAdded",
  "Data": {
    "Key": "8f3a1b2c-0000-0000-0000-000000000001",
    "Kind": "queue",
    "Type": null,
    "Name": "InvoiceQueue",
    "Folder": "solution_folder",
    "FolderKey": "5c2d61f4-0000-0000-0000-000000000001",
    "Source": "local",
    "Status": "Added"
  }
}

Status is one of Added, Updated, or Unchanged (the idempotent no-op case).

remove

Remove a resource from the solution by its key. Purely local — no authentication required, and it doesn't touch any project's bindings_v2.json.

Argumentos

Name	Required	Finalidade
<resource-key>	sim	Solution resource key (GUID). Use resources list or resources get to discover it.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Path to the solution root folder.

Exemplos

uip solution resources remove 8f3a1b2c-1234-4abc-9def-0123456789ab

Formato dos dados (--output json)

{
  "Code": "ResourceRemoved",
  "Data": {
    "Key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "Kind": "queue",
    "Name": "InvoiceQueue",
    "Folder": "solution_folder"
  }
}

edit

Edit a resource's spec properties by key. --patch takes a JSON object of property → value, merged into the existing spec; properties the SDK marks as reference/read-only/unknown are silently ignored. The get and edit data shapes match, so a get → modify → edit round-trip is straightforward. --source remote takes the values from the cloud definition the resource was imported from instead of --patch.

Argumentos

Name	Required	Finalidade
<resource-key>	sim	Solution resource key (GUID).

Opções

Long	Valor	Padrão	Description
--patch	JSON or -	—	JSON object of spec property → value. Pass - to read the JSON from stdin instead.
--source	local | remote	local	Where the new values come from: --patch (local), or the cloud definition (remote).
--force	Bandeira	desativada	With --source remote, write the cloud definition over the local one.
--solution-folder	Path	diretório atual	Path to the solution root folder.
--login-validity	minutos	10	Minimum minutes before token expiration to trigger a refresh. Used only by --source remote.

Exemplos

uip solution resources edit 8f3a1b2c-1234-4abc-9def-0123456789ab \
  --patch '{"maxNumberOfRetries":5}'

# Pipeline-friendly: patch from stdin
echo '{"slaInHours":"4"}' | uip solution resources edit 8f3a1b2c-... --patch -

# Pull the cloud definition: report the differences, then overwrite
uip solution resources edit 8f3a1b2c-... --source remote
uip solution resources edit 8f3a1b2c-... --source remote --force

Formato dos dados (--output json)

{
  "Code": "ResourceEdited",
  "Data": {
    "key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "spec": { "name": "InvoiceQueue", "maxNumberOfRetries": 5 },
    "locks": [],
    "apiVersion": "orchestrator.uipath.com/v1"
  }
}

With --source remote and no --force, the command writes nothing: it exits 1 and names the properties that differ. If nothing differs it succeeds with Code: "ResourceRemoteDrift" and Applied: false. With --force the response is ResourceEdited, carrying Changed, Skipped (properties the resource kind does not let the SDK write), and Applied: true.

refresh

Re-scan every project in the solution and sync resource declarations from their bindings_v2.json files. Bindings not yet in the solution's resource list are created; bindings matching an existing Orchestrator resource are imported; duplicate copies of the solution's own projects that an earlier run imported from a deployed folder are pruned. Run this after editing project bindings to bring the solution's resource inventory back in step.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Path to the solution root folder.
--login-validity	minutos	10	Minimum minutes before token expiration to trigger a refresh.

Exemplos

uip solution resources refresh

Formato dos dados (--output json)

{
  "Code": "ResourceRefresh",
  "Data": {
    "Created": 2,
    "Imported": 1,
    "Skipped": 5,
    "Pruned": 0,
    "Warnings": [],
    "Status": "Synced 3 resources (5 already in solution)"
  }
}

Created is the count of brand-new solution resources; Imported is the count matched against Orchestrator; Skipped counts bindings that already had a matching solution entry; Pruned counts duplicate project-copies removed (only named in Status when non-zero). Warnings is a list of human-readable notes from the sync (empty on a clean run).

Códigos de saída

Consulte Códigos de saída para o contrato compartilhado.

Comandos relacionados

• uip solution pack — o empacotamento lê a lista de recursos da solução.
• uip solution deploy — implantar recursos de provisionamento no tenant de destino.
• uip or — the server-side CRUD tool for live Orchestrator resources.

Veja também

• Opções globais — --output, --output-filter, --log-level, --log-file.
• Códigos de saída — contrato de código de saída padrão.