- 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 api-workflow validate
Syntax and options for `uip api-workflow validate`, which checks an API Workflow JSON file's structure before packaging or running it.
uip api-workflow validate checks an API Workflow JSON file's structure — task shapes, expressions, and metadata — against schema, without executing it. Use it as a fast pre-flight check before run or pack.
For File to Base64 and Base64 to File activities, validation also checks that the task's script calls $helpers.file.fileToBase64(...) or $helpers.file.base64ToFile(...) with that exact name. Any other spelling is reported as an error, because the run would fail with "is not a function".
Synopsis
uip api-workflow validate <file> [options]
uip api-workflow validate <file> [options]
<file>— path to the API Workflow JSON file to validate.
Options
| Flag | Description |
|---|---|
--verbose | Enable verbose logging, including a stack trace if validation itself throws. |
Examples
uip api-workflow validate ./workflow.json
uip api-workflow validate ./workflow.json
uip api-workflow validate ./workflow.json --verbose
uip api-workflow validate ./workflow.json --verbose
Data shape (--output json)
{
"Code": "ApiwfValidate",
"Data": {
"File": "/abs/path/to/workflow.json",
"Status": "Valid"
}
}
{
"Code": "ApiwfValidate",
"Data": {
"File": "/abs/path/to/workflow.json",
"Status": "Valid"
}
}
When validation passes with warnings, Data adds a Warnings field summarizing the count and each warning's path and message. When validation fails (errors present), the command exits non-zero and reports a Failure result whose Instructions field lists every issue found, each tagged [error] or [warning] with its JSON path.
Related
- uip api-workflow run — execute the workflow after it validates clean.
- uip api-workflow pack — package a validated workflow for publication.