- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip rules describe
Syntax and options for `uip rules describe`, which returns the entry points and argument schemas of a deployed business rule's active version.
uip rules describe is labeled Preview in the command help. Refer to Versioning for what the Preview label means.
uip rules describe returns the entry points of a deployed business rule's active version, with their input and output argument schemas. Use them to map arguments when you bind the rule from a BPMN process, RPA workflow, or case. The rows have the same shape as uip or packages entry-points.
describe reads the rule in the tenant of your current session. To read a rule in another tenant, switch tenants with uip login tenant set first.
Synopsis
uip rules describe <rule-name> (--folder-path <path> | --folder-key <key>)
uip rules describe <rule-name> (--folder-path <path> | --folder-key <key>)
Arguments
| Name | Required | Purpose |
|---|---|---|
<rule-name> | yes | Business rule name. |
Options
Pass exactly one of --folder-path or --folder-key.
| Long | Value | Description |
|---|---|---|
--folder-path | string | Folder path, for example Shared. |
--folder-key | GUID | Folder key. |
Example
uip rules describe LoanEligibility --folder-path "Shared"
uip rules describe LoanEligibility --folder-path "Shared"
Data shape (--output json)
{
"Code": "RulesEntryPoints",
"Data": [
{
"UniqueId": "8a0f5c3e-2d1b-4f6a-9e7c-1b2a3c4d5e6f",
"Path": "/LoanEligibility.dmn#Decision_Eligibility",
"DisplayName": "Eligibility",
"InputArguments": "{\"type\":\"object\",\"properties\":{\"creditScore\":{\"type\":\"number\"}}}",
"OutputArguments": "{\"type\":\"object\",\"properties\":{\"eligible\":{\"type\":\"boolean\"}}}"
}
]
}
{
"Code": "RulesEntryPoints",
"Data": [
{
"UniqueId": "8a0f5c3e-2d1b-4f6a-9e7c-1b2a3c4d5e6f",
"Path": "/LoanEligibility.dmn#Decision_Eligibility",
"DisplayName": "Eligibility",
"InputArguments": "{\"type\":\"object\",\"properties\":{\"creditScore\":{\"type\":\"number\"}}}",
"OutputArguments": "{\"type\":\"object\",\"properties\":{\"eligible\":{\"type\":\"boolean\"}}}"
}
]
}
InputArguments and OutputArguments are JSON schemas serialized as strings.
Exit codes
Refer to Exit codes for the shared contract. The command exits 1 in these cases:
| Condition | ErrorCode |
|---|---|
| The folder holds no rule with this name. | not_found |
The deployed rule carries no argument contract. Redeploy it from its solution with uip solution publish and uip solution deploy run. | configuration_error |
Neither or both of --folder-path and --folder-key are passed. | invalid_argument |
Related commands
uip rules getgets the rule and its current version.uip rules versionslists the rule's versions.uip solution deploydeploys the solution that holds the rule.
See also
uip rulesfor the tool overview.