uip resource

uip resource manages the Orchestrator resources that automations depend on at runtime — assets, buckets and bucket files, libraries, queues and queue items, triggers, and webhooks. It is the general-purpose CRUD surface over these entities, separate from uip solution resource (which inspects local solution resource declarations) and from uip or (the Orchestrator automation tool for jobs, processes, folders, and so on).

注:

The tool alias is resource (singular), not resources. Every example uses uip resource <kind>.

uip resource is provided by the @uipath/resource-tool plugin. If it is not yet installed, uip tools install resource adds it. See Tools (plugins).

リソース

Each resource has its own reference page. The verb set on each page matches the commands registered by uip resource — run uip resource --help to confirm the full surface on your installation.

リソース	目的
アセット	Named configuration values (Text, Bool, Integer, Credential, Secret) used by automations at runtime. Folder-scoped.
buckets	Storage containers for files used by automations. Folder-scoped.
bucket-files	Individual files inside a bucket. List, upload, download, delete, fetch pre-signed URLs.
libraries	Reusable .nupkg packages (shared activities and logic). Tenant-scoped.
キュー	Containers for transactional work items. Folder-scoped.
queue-items	Individual transactions inside queues, with full state-machine controls. Folder-scoped.
トリガー	Time, queue, and API triggers that start jobs. Time/queue triggers are folder-scoped; API triggers are tenant-scoped.
Webhook	HTTP callbacks fired on platform events (job completion, queue-item failure, …). Tenant-scoped.

Synopsis

uip resource <resource> <verb> [options]

Default output is JSON. Every subcommand honors the global options (--output, --output-filter, --log-level, --log-file) and returns the standard exit codes.

命名規則

• Authentication. Every uip resource subcommand calls Orchestrator. Run uip login first, or pass -t, --tenant <tenant-name> on any subcommand to target a specific tenant within your authenticated organization.
• Folder scoping. Assets, buckets, queues, queue items, and triggers (time / queue) are folder-scoped. Provide either --folder-path <path> (e.g. "Shared") or --folder-key <guid> on list, create, and related calls. get, update, and delete resolve cross-folder by key when feasible — each verb's description on the resource page calls it out explicitly. Libraries, API triggers, and webhooks are tenant-scoped and do not accept --folder-*.
• Keys. Most resources are identified by a GUID returned in list output (under key, identifier, or — for queue items — uniqueKey for a single attempt and key for the retry chain). Numeric id fields are internal and should not be passed to commands.
• Paging. List verbs accept -l, --limit <n>, --offset <n>, and --order-by <field> (OData syntax, e.g. "Name asc"). Bucket file list is the exception and uses a continuationToken.
• Filtering. Where supported, -n, --name <name> is a contains-match on the resource name; some resources add --enabled, --disabled, --status, etc.

Data shape

Successful output always follows the standard envelope:

{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}

The Code per verb is documented on the resource page (AssetList, AssetCreated, BucketFile, QueueItemAdded, TriggerEnabled, WebhookPinged, etc.). Data is either a single object (get, create, update) or an array (list, versions, event-types, history).

Listings are currently unwrapped — they do not include a top-level count or nextPage field. Bucket file list is the exception; its payload includes a continuationToken used for paging.

Worked examples

List queues in a folder

uip resource queues list --folder-path Shared

Create an asset, then share it across folders

uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production

Bulk-add queue items from a JSON file

ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json

Related commands

• uip solution deploy config link — bind a solution's declared resource to one of the assets / queues / buckets created via uip resource.
• uip solution resource list — inspect the resource declarations inside a local solution.
• uip or — for folders, processes, releases, jobs, machines, users, and credential stores that you will often need to look up keys from when using uip resource.

参照

• Authentication — every subcommand requires an active session.
• Configuration — pin default tenant / folder values per project.
• Global options and Exit codes — contracts shared by every verb.