uip rules get

Syntax and options for `uip rules get`, which gets a business rule deployed to an Orchestrator folder by name, with its tags and timestamps.

Observação:

uip rules get is labeled Preview in the command help. Refer to Versioning for what the Preview label means.

uip rules get gets one business rule deployed to an Orchestrator folder by name. It returns the same fields as uip rules list, plus the rule's tags and timestamps. Use uip rules versions for the rule's version history and uip rules describe for its argument schemas.

Resumo

uip rules get <rule-name> (--folder-path <path> | --folder-key <key>)

Argumentos

Name	Required	Finalidade
<rule-name>	sim	Business rule name.

Opções

Pass exactly one of --folder-path or --folder-key.

Long	Valor	Description
--folder-path	String	Folder path, for example Shared.
--folder-key	GUID	Chave da pasta.

Exemplo

uip rules get LoanEligibility --folder-path "Shared"

Formato dos dados (--output json)

{
  "Code": "RulesGet",
  "Data": {
    "Key": "3f1c2a9e-8b4d-4e2a-9c1f-6d7e8f9a0b1c",
    "Name": "LoanEligibility",
    "FolderPath": "Shared",
    "FolderKey": "9b2d4f6a-1c3e-4a5b-8d7f-0e1a2b3c4d5e",
    "Description": "Decides loan eligibility",
    "CurrentVersion": "1.0.2",
    "Tags": [],
    "CreationTime": "2026-09-01T10:00:00.000Z",
    "LastModificationTime": "2026-09-20T08:30:00.000Z"
  }
}

Códigos de saída

Refer to Exit codes for the shared contract. The command exits 1 in these cases:

Condição	ErrorCode
The folder holds no rule with this name.	not_found
Neither or both of --folder-path and --folder-key are passed.	invalid_argument

Comandos relacionados

• uip rules list lists the rules in a folder.
• uip rules versions lists the rule's versions.
• uip rules describe returns the rule's entry points and argument schemas.

Veja também

• uip rules for the tool overview.