uip admin rcs

Syntax and options for `uip admin rcs`, which searches Resource Catalog Service entities and lists tenant tags.

uip admin rcs queries the Resource Catalog Service (RCS) — the platform-wide index of automatable entities (processes, orchestration objects, and other resource types) that back pickers like Orchestrator's "Add Tool" UI — plus the tenant-scoped tags RCS tracks for those entities. Part of uip admin (overview), the UiPath admin tool.

Resumo

uip admin rcs search [--entity-type <type>]... [--entity-sub-type <type>]... [--name <text>] [--folder-key <guid> | --folder-path <path>] [--limit <n>] [--offset <n>]
uip admin rcs tag list [--type Label|KeyValue] [--starts-with <prefix>] [--limit <n>] [--offset <n>]

Both verbs accept --login-validity <minutes>.

uip admin rcs search

Search RCS entities (GET /Entities/Search) — for example, to reproduce what Orchestrator's Add-Tool picker sees.

Opções

Long	Valor	Description
--entity-type <value>	string, repeatable	RCS entityTypes filter entry (e.g. Process). Repeat for multiple values.
--entity-sub-type <value>	string, repeatable	RCS entitySubType filter entry (e.g. ProcessOrchestration). Repeat for multiple values.
--name <text>	String	Substring filter on entity name.
--folder-key <guid>	GUID	Scope the search to one folder (sent as X-UIPATH-FolderKey).
--folder-path <path>	String	Scope the search to one folder by path (sent as X-UIPATH-FolderPath).
--limit <n>	Número inteiro	Page size (RCS take). Default 100.
--offset <n>	Número inteiro	Row offset (RCS skip). Default 0.
--login-validity <minutes>	Número inteiro	Override the interactive-login token lifetime for this call. Rarely needed.

Exemplos

# Search RCS Process entities by entitySubType (matches the Orchestrator UI Add-Tool picker)
uip admin rcs search --entity-type Process --entity-sub-type ProcessOrchestration --limit 8

# Search across one folder by key
uip admin rcs search --entity-type Process --folder-key 11111111-1111-1111-1111-111111111111

Formato dos dados (--output json)

{
  "Code": "RcsSearch",
  "Data": {
    "items": [
      {
        "entityKey": "entity-guid",
        "name": "Sample Orchestrator",
        "entityType": "Process",
        "entitySubType": "ProcessOrchestration"
      }
    ],
    "total": 1,
    "count": 1
  }
}

next ({ skip, take }) is present only when more rows remain beyond this page — use it to page forward with --offset.

uip admin rcs tag

List tenant-scoped tags tracked by RCS.

uip admin rcs tag list

Lists tags for the tenant in your login context. Switch tenants with uip login tenant set <tenant> (your account needs RCS access to that tenant).

Opções

Long	Valor	Description
--type <type>	Label | KeyValue	Tag type. Default Label. Case-sensitive.
--starts-with <prefix>	String	Return only tags whose normalized name starts with this prefix (case-insensitive).
--limit <n>	Número inteiro	Page size. Default 100.
--offset <n>	Número inteiro	Row offset. Default 0.
--login-validity <minutes>	Número inteiro	Override the interactive-login token lifetime for this call. Rarely needed.

Exemplos

uip admin rcs tag list

uip admin rcs tag list --starts-with env --limit 20

Formato dos dados (--output json)

{
  "Code": "RcsTagList",
  "Data": {
    "count": 2,
    "value": [
      { "displayName": "Environment", "normalizedName": "environment" },
      { "displayName": "Owner", "normalizedName": "owner" }
    ]
  }
}

Solução de problemas

• "Invalid scope(s)" on tag list — re-run uip login to mint a token carrying the RCS.Tags scope.
• Both verbs require an active login with Resource Catalog Service access — run uip login first.

Relacionado

• uip admin — overview of the whole uip admin tool.
• uip or audit-logs — a related but distinct audit surface, scoped to Orchestrator entities rather than the platform-wide RCS index.

Veja também

• Opções globais
• Códigos de saída