Loading...
Loading...
UiPath Test Manager — manage test projects, cases, sets, executions; generate reports; package and run external Playwright test suites. For Orchestrator→uipath-platform. For Studio/RPA test automation authoring→uipath-rpa.
npx skill4agent add uipath/skills uipath-testPW_Tag_*PW_Project_*PW_Suite_*PW_File_*uip tmuip tm --helpuip tm <command> <subcommand> --help--output jsonuipuip tm| Command | Purpose |
|---|---|
| Find a project by name or key. |
| Create a new Test Manager project. |
| Update project name or description. |
| Delete a Test Manager project. |
| Set the default Orchestrator folder for a project. |
| Clear the default Orchestrator folder from a project. |
| List the owners of one or more Test Manager projects. |
Get folder keys with— returns all folders visible to the current user.uip or folders list -n <name> --all --output json
| Command | Purpose |
|---|---|
| List requirements in a Test Manager project. |
| List requirements covered by a test execution. |
| Get a requirement by UUID or key (mutually exclusive). |
| Create a new requirement. |
| Update a requirement name or description (at least one of |
| Delete one or more requirements (variadic). |
| Export requirements to an .xlsx file. |
| List the test case UUIDs assigned to a requirement. |
| Attach or detach test cases on a requirement (mutually exclusive). |
| Command | Purpose |
|---|---|
| Create a new test case in a Test Manager project. |
| List all test cases in a Test Manager project. Optional |
| Update a test case name, description, precondition, or postcondition (at least one field required). |
| Delete a test case by its key. |
| Link an Orchestrator package automation to a test case. |
| Unlink the automation from a test case. |
| List test entry points available in an Orchestrator folder (optional: |
| List test sets that contain a given test case. |
| List manual test steps for a test case. Uses |
| Get a single test step by its UUID. |
| Add a step using flags ( |
| Add multiple steps by repeating |
| Update a step's fields. Only fields you pass change; the rest stay. |
| Move a step to a new 0-based position. |
| Delete a step. |
| List test case log result history for a specific test case. Optional |
| Start a new execution for one or more test cases. Uses |
| Add test cases to a test set — by explicit keys, OR every test case carrying at least one of the given labels. Both selectors are variadic and space-separated: |
| Remove test cases from a test set (comma-separated keys). |
Flag shapes for test case and step identifiers — do not interchange:
— used by--test-case-id <UUID>,run,steps list,steps add. Get the UUID fromlist-result-history(uip tm testcases list --output jsonfield).Id — singular, used by--test-case-key <PROJECT_KEY:NUMBER>,update,delete,link-automation,unlink-automation. Example:list-testsets.DEMO:1 — plural, comma-separated, used by--test-case-keys <KEY1,KEY2,...>andtestcases addfor bulk membership changes on a test set.testcases remove — used by all--step-id <UUID>subcommands exceptstepsandlist. Get the UUID fromadd(steps listfield).Id
| Command | Purpose |
|---|---|
| Create a new test set in a Test Manager project. |
| List test sets in a Test Manager project. Optional |
| Update a test set name or description. |
| Delete a test set by its key. |
| List test cases assigned to a test set. |
| Run a test set and return the execution ID. Optional |
| Probe whether a test set is a Playwright test set: returns |
Keys use the format(e.g.,PROJECT_KEY:NUMBER). To add or remove test cases in a test set, useINV:42/uip tm testcases add— those verbs live under theuip tm testcases removegroup, not undertestcases.testsets
Playwright test sets:(space-separated, case-sensitive--playwright-projects <names...>project names) runs only the selected projects and persists the selection on the test set. It requires every test case in the set to come from one Playwright package; unknown names fail fast listing the valid ones. Probe first withplaywright.configand branch onplaywright-context. Both need a Test Manager with Playwright support and a CLI carrying the external-package commands — references/playwright-first-mile-guide.md opens with the check to run and what to do when they are absent.IsPlaywright
| Command | Purpose |
|---|---|
| List top n executions for a project. Optional |
| Rich-filter variant: |
| Get aggregated statistics for a single test execution. |
| Re-run an existing test execution. Optional |
| Retry only the failed test cases of a finished execution. Optional |
| List test case logs of an execution. Optional |
lives under three groups, all distinct:run
— start a new execution for one or more test cases (uip tm testcases runUUIDs, space-separated).--test-case-id — start a new execution for an entire test set (uip tm testsets run).--test-set-key — re-run an existing execution byuip tm executions run, optionally narrowed to specific--execution-id.--test-case-log-ids
| Command | Purpose |
|---|---|
| Start a test case execution within a running test execution. Optional |
| Finish a started test case execution. Optional |
| List assertions of a test case log. |
| Command | Purpose |
|---|---|
| List test step logs for a test case log. |
| Command | Purpose |
|---|---|
| Get a summary report for a completed test execution. One of |
| Command | Purpose |
|---|---|
| Download attachments for test cases in an execution. |
| Upload a file as an attachment to a Test Manager object (e.g. |
| Command | Purpose |
|---|---|
| Download test execution results as JUnit XML. Optional |
| Command | Purpose |
|---|---|
| Pack a Playwright suite into a |
Packing is offline — no auth needed. The upload → ingestion → label-fill → run pipeline is in references/playwright-first-mile-guide.md.
| Command | Purpose |
|---|---|
| Wait for a test execution to reach a terminal state. Optional |
| Command | Purpose |
|---|---|
| Get profile data for the currently authenticated user. |
labelvalue--object-typeRequirementTestCaseTestSet--data-typeTextLabel| Command | Purpose |
|---|---|
| List custom field definitions. Optional |
| Get a custom field definition by UUID, OR identify by |
| Create a new custom field definition. Pass |
| Update a custom field definition. Identify by |
| Delete one or more custom field definitions by UUID (variadic), OR singleton by |
customfield label--object-type <Requirement\|TestCase\|TestSet>| Command | Purpose |
|---|---|
| List label rows. Optional |
| Get a single label row by UUID. |
| Upsert a label row on one object. |
| Append values to a label field across multiple objects. Optional |
| Remove values from a label field across multiple objects. |
customfield value--object-type <Requirement\|TestCase\|TestSet>create--data-type <Text\|Label>| Command | Purpose |
|---|---|
| List value rows. Results are empty unless |
| Get a value row by UUID, OR by |
| Create a value row. Optional |
| Update a value row by UUID, OR by |
| Delete a value row by UUID, OR by |
--object-type--object-ids| Command | Purpose |
|---|---|
| List distinct label names for one |
| Get a single label-assignment row by UUID. |
| Attach labels to objects (variadic; one-to-one, one-to-many, many-to-many). Optional |
| Detach labels from objects. |
uip login status --output jsonuip loginuip tmuip tm testcases --help --output jsonSuccessunknown commandunknown command--output jsonuipuiptm testcases list --filterdelete--yes-yuip or folders list -n <folder-name> --all --output json--all/uipath-platformlistuip tm testcases list-automationsuip or folders list -n <folder-name> --alllistuip tm <resource> list --helpuip or <resource> list --helplistuip tmuip ortm testcases list --filter--filter--filter--limit--offsetrunuip tm testcases runuip tm testsets runrun"Message": "HTTP 400: Please assign folder to project level before executing testcases."errorCode: itemNotFounduip tm project set-default-folder --project-key <PROJECT_KEY> --folder-key <FOLDER_KEY> --output jsonuip or folders list -n <folder-name> --all --output jsonHTTP 5xxset-default-folder"HTTP 400: Internal Server Error."errorCode: unknownor folders listuipuiprun"HTTP 400: Please assign folder to project level before executing testcases."uip tm wait"Timed out after <N>s waiting for execution '<EXECUTION_ID>'. Last status: <status>."--timeoutwaitPolling failed/interrupted/aborted ...| Post-rename (tables above) | Pre-rename equivalent |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
uip tm waittm testcaselogtm reporttm resulttm attachmenttm projecttm usertm requirementuip login status --output jsonuip loginuip login tenant set <TENANT_NAME> --output json/uipath-platformPROJECT_KEYuip tm project list --filter <NAME_OR_KEY> --output jsonPROJECT_KEY # Get project
uip tm project list --filter <PROJECT_NAME_OR_KEY> --output json
# List test sets in a project
uip tm testsets list --project-key <PROJECT_KEY> --filter <TEST_SET_NAME_OR_KEY> --output json
# List test cases assigned to a test set
uip tm testsets list-testcases --project-key <PROJECT_KEY> --test-set-key <TEST_SET_KEY> --output json
# List recent executions for a test set
uip tm executions list --project-key <PROJECT_KEY> --test-set-id <TEST_SET_ID> --limit 100 --output json
# List test case logs for an execution (nested subcommand under `executions`)
uip tm executions testcaselogs list --execution-id <EXECUTION_ID> --project-key <PROJECT_KEY> --output json
# List assertions of a test case log
uip tm testcaselog list-assertions --project-key <PROJECT_KEY> --test-case-log-id <TEST_CASE_LOG_ID> --output json
# List step-level logs of a test case log
uip tm teststeplog list --project-key <PROJECT_KEY> --test-case-log-id <TEST_CASE_LOG_ID> --output json| Problem | Fix |
|---|---|
| |
If a command fails unexpectedly:
- Verify the command syntax:
uip tm <command> --help- Check authentication:
uip login status --output json
| I want to... | Start here |
|---|---|
| Generate a shareable test report (tester or release manager view) | references/test-result-report-guide.md |
| Publish a project and link it to a Test Manager test case (Studio/RPA) | references/publish-and-link-guide.md |
| Pack, ingest, and run a Playwright suite on serverless (pack → upload → labels → run) | references/playwright-first-mile-guide.md |
unknown commanduip tm <resource> --help --output jsonlink-automation