uip rules list

Syntax and options for `uip rules list`, which lists the business rules deployed to an Orchestrator folder with their current version.

Remarque :

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

uip rules list lists the business rules deployed to an Orchestrator folder. Each row returns the rule's key, name, folder, description, and current version. An empty folder returns Data: [].

Synthèse

uip rules list (--folder-path <path> | --folder-key <key>) [-l <number>] [--offset <number>]

Options

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

Short	Long	Valeur (Value)	Default	Description
	--folder-path	string	—	Folder path, for example Shared.
	--folder-key	GUID	—	Clé de dossier.
-l	--limit	integer (1–10000)	50	Number of rules to return.
	--offset	Integer	0	Number of rules to skip.

Exemple

uip rules list --folder-path "Shared" --limit 1

Format des données (--sortie json)

{
  "Code": "RulesList",
  "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"
    }
  ]
}

The envelope also carries a Pagination object with Returned, Limit, Offset, and HasMore.

Codes de sortie

Refer to Exit codes for the shared contract. The command exits 1 with ErrorCode: "invalid_argument" when neither or both of --folder-path and --folder-key are passed.

Commandes associées

• uip rules get gets one rule by name.
• uip or folders list finds folder paths and keys.

Voir également

• uip rules for the tool overview.