UiPath CLI - uip tm testsets

uipath-cli

latest

false

UiPath CLI user guide

uip tm testsets

Syntax and options for `uip tm testsets`, which manages the executable test-set units that produce tracked executions in Test Manager.

uip tm testsets manages test sets: the executable unit in Test Manager. A test set is an ordered group of test cases launched as a single command and tracked as a single execution. Every testsets run call returns an ExecutionId that the other uip tm verbs (wait, executions, report, result, attachment) take as input.

Synopsis

uip tm testsets create --project-key <key> --name <name> [--description <text>]
uip tm testsets list --project-key <key> [--filter <text>]
uip tm testsets update --project-key <key> --test-set-key <key> [--name <name>] [--description <text>]
uip tm testsets delete --project-key <key> --test-set-key <key> [-y]
uip tm testsets list-testcases --project-key <key> --test-set-key <key> [--limit <n>] [--offset <n>]
uip tm testsets run --test-set-key <key> [--execution-type <type>] [--input-path <file>] [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
uip tm testsets create --project-key <key> --name <name> [--description <text>]
uip tm testsets list --project-key <key> [--filter <text>]
uip tm testsets update --project-key <key> --test-set-key <key> [--name <name>] [--description <text>]
uip tm testsets delete --project-key <key> --test-set-key <key> [-y]
uip tm testsets list-testcases --project-key <key> --test-set-key <key> [--limit <n>] [--offset <n>]
uip tm testsets run --test-set-key <key> [--execution-type <type>] [--input-path <file>] [--wait [--timeout <seconds>] [--poll-interval <seconds>]]

All verbs honor the global options and the standard exit codes. Every verb accepts --log-level <level> (default Information).

uip tm testsets create

Create an empty test set in a project.

Arguments

None.

Options

Flag	Description
`--project-key <key>`	Required. Owning project.
`--name <name>`	Required. Test set name.
`--description <text>`	Free-form description. Defaults to empty.

Example

uip tm testsets create \
  --project-key DEMO \
  --name "Smoke Suite" \
  --description "Core smoke tests"
uip tm testsets create \
  --project-key DEMO \
  --name "Smoke Suite" \
  --description "Core smoke tests"

Data shape

{
  "Code": "TestSetCreate",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Name": "Smoke Suite",
    "Description": "Core smoke tests"
  }
}
{
  "Code": "TestSetCreate",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Name": "Smoke Suite",
    "Description": "Core smoke tests"
  }
}

uip tm testsets list

List test sets in a project.

Arguments

None.

Options

Flag	Description
`--project-key <key>`	Required. Project to list.
`--filter <text>`	Server-side search over name.

Example

uip tm testsets list --project-key DEMO --filter smoke
uip tm testsets list --project-key DEMO --filter smoke

Data shape

{
  "Code": "TestSetsList",
  "Data": [
    {
      "TestSetKey": "DEMO:10",
      "Name": "Smoke Suite",
      "Id": "a1b2c3d4-0000-0000-0000-000000000010"
    }
  ]
}
{
  "Code": "TestSetsList",
  "Data": [
    {
      "TestSetKey": "DEMO:10",
      "Name": "Smoke Suite",
      "Id": "a1b2c3d4-0000-0000-0000-000000000010"
    }
  ]
}

Id is the internal UUID — needed by executions list --test-set-id.

uip tm testsets update

Rename a test set or change its description. At least one of --name or --description must be supplied.

Arguments

None.

Options

Flag	Description
`--project-key <key>`	Required. Owning project.
`--test-set-key <key>`	Required. Test set key (for example, `DEMO:10`).
`--name <name>`	New name.
`--description <text>`	New description.

Example

uip tm testsets update \
  --project-key DEMO \
  --test-set-key DEMO:10 \
  --name "Smoke Suite (2026)"
uip tm testsets update \
  --project-key DEMO \
  --test-set-key DEMO:10 \
  --name "Smoke Suite (2026)"

Data shape

{
  "Code": "TestSetUpdate",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Name": "Smoke Suite (2026)",
    "Description": "Core smoke tests",
    "Result": "Updated"
  }
}
{
  "Code": "TestSetUpdate",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Name": "Smoke Suite (2026)",
    "Description": "Core smoke tests",
    "Result": "Updated"
  }
}

uip tm testsets delete

Delete a test set by its key.

Arguments

None.

Options

Flag	Description
`--project-key <key>`	Required. Owning project.
`--test-set-key <key>`	Required. Test set key (for example, `DEMO:10`).
`-y, --yes`	Skip the confirmation prompt. Required in non-interactive environments.

Example

uip tm testsets delete --project-key DEMO --test-set-key DEMO:10 --yes
uip tm testsets delete --project-key DEMO --test-set-key DEMO:10 --yes

Data shape

{
  "Code": "TestSetDelete",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Id": "a1b2c3d4-0000-0000-0000-000000000010",
    "Result": "Deleted"
  }
}
{
  "Code": "TestSetDelete",
  "Data": {
    "TestSetKey": "DEMO:10",
    "Id": "a1b2c3d4-0000-0000-0000-000000000010",
    "Result": "Deleted"
  }
}

uip tm testsets list-testcases

List the test cases assigned to a test set.

Arguments

None.

Options

Flag	Description
`--project-key <key>`	Required. Owning project.
`--test-set-key <key>`	Required. Test set to inspect.
`--limit <n>`	Maximum number of results per page. Defaults to `50`.
`--offset <n>`	Number of results to skip. Defaults to `0`.

Example

uip tm testsets list-testcases --project-key DEMO --test-set-key DEMO:10
uip tm testsets list-testcases --project-key DEMO --test-set-key DEMO:10

Data shape

{
  "Code": "TestSetTestCasesList",
  "Data": [
    {
      "TestCaseKey": "DEMO:1",
      "Name": "Login smoke",
      "Description": "Logs in and out"
    }
  ]
}
{
  "Code": "TestSetTestCasesList",
  "Data": [
    {
      "TestCaseKey": "DEMO:1",
      "Name": "Login smoke",
      "Description": "Logs in and out"
    }
  ]
}

uip tm testsets run

Run a test set and return its ExecutionId. By default the command returns as soon as the execution is queued. Pass --wait to block until the execution reaches a terminal state — this combines the launch and wait steps into one command.

Arguments

None.

Options

Flag	Description
`--test-set-key <key>`	Required. Test set object key (for example, `DEMO:42`). The project key is derived from the prefix.
`--execution-type <type>`	Type of test cases to execute: `automated` (default), `manual`, `mixed` (both automated and manual), or `none` (no type filter).
`--input-path <file>`	Path to a JSON file containing parameter overrides for the execution. Format: `[{"name":"Param","type":"String","value":"v"}]`.
`--wait`	Block until the execution reaches a terminal state (`finished`, `cancelled`). When omitted, the command returns immediately after queuing.
`--timeout <seconds>`	Maximum seconds to wait for the execution to finish (`0` for no timeout). Requires `--wait`.
`--poll-interval <seconds>`	Seconds between status checks while waiting. Requires `--wait`.

Examples

# Fire-and-forget — returns ExecutionId immediately
uip tm testsets run --test-set-key DEMO:10

# Block until done — no need for a separate uip tm wait call
uip tm testsets run \
  --test-set-key DEMO:10 \
  --wait

# Block with a timeout and custom poll interval
uip tm testsets run \
  --test-set-key DEMO:10 \
  --execution-type automated \
  --wait \
  --timeout 900 \
  --poll-interval 15

# Pass parameter overrides from a file
uip tm testsets run \
  --test-set-key DEMO:10 \
  --input-path ./params.json \
  --wait
# Fire-and-forget — returns ExecutionId immediately
uip tm testsets run --test-set-key DEMO:10

# Block until done — no need for a separate uip tm wait call
uip tm testsets run \
  --test-set-key DEMO:10 \
  --wait

# Block with a timeout and custom poll interval
uip tm testsets run \
  --test-set-key DEMO:10 \
  --execution-type automated \
  --wait \
  --timeout 900 \
  --poll-interval 15

# Pass parameter overrides from a file
uip tm testsets run \
  --test-set-key DEMO:10 \
  --input-path ./params.json \
  --wait

Data shape

{
  "Code": "TestSetRun",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "TestSetKey": "DEMO:10",
    "Status": "Running",
    "StartTime": "2025-04-15T10:30:00Z"
  }
}
{
  "Code": "TestSetRun",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "TestSetKey": "DEMO:10",
    "Status": "Running",
    "StartTime": "2025-04-15T10:30:00Z"
  }
}

Note:

When --wait is used, Status reflects the terminal state (Finished, Cancelled) rather than Running. The returned ExecutionId is the same in both cases and can be passed to uip tm report get, uip tm result download, and uip tm attachment download.

testcases — create and link the test cases that populate a test set.
executions — list and retry executions once a test set has been run.
wait — block until a returned ExecutionId reaches a terminal state.
report, result, attachment — post-run artifacts.

Was this page helpful?

PREVIOUStestcases

NEXTteststeplog

Synopsis​

uip tm testsets create​

Arguments​

Options​

Example​

Data shape​

uip tm testsets list​

Arguments​

Options​

Example​

Data shape​

uip tm testsets update​

Arguments​

Options​

Example​

Data shape​

uip tm testsets delete​

Arguments​

Options​

Example​

Data shape​

uip tm testsets list-testcases​

Arguments​

Options​

Example​

Data shape​

uip tm testsets run​

Arguments​

Options​

Examples​

Data shape​

Related​

See also​

Was this page helpful?

Synopsis

uip tm testsets create

Arguments

Options

Example

Data shape

uip tm testsets list

Arguments

Options

Example

Data shape

uip tm testsets update

Arguments

Options

Example

Data shape

uip tm testsets delete

Arguments

Options

Example

Data shape

uip tm testsets list-testcases

Arguments

Options

Example

Data shape

uip tm testsets run

Arguments

Options

Examples

Data shape

Related

See also