uipath-cli
latest
false
UiPath CLI user guide
- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip docsai
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-workflow-examples
- pack
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migration
- Reference & support
Syntax and options for `uip tm objectlabel`, which manages labels attached to Test Manager objects such as test cases and requirements.
uip tm objectlabel manages labels attached to Test Manager objects (test cases, requirements, and so on). Labels are free-form strings used to tag and group objects for filtering and search.
Important:
--object-ids and --labels are plural and space-separated throughout this command group. The singular forms --object-id and --label do not exist. --project-key is required on list.
Synopsis
uip tm objectlabel list --project-key <key> [--object-ids <uuid...>] [--label-types <types...>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm objectlabel get --label-id <uuid>
uip tm objectlabel add --object-ids <uuid...> --labels <name...> [--label-type <type>] [--remove-other-labels]
uip tm objectlabel remove --object-ids <uuid...> (--labels <name...> | --remove-all-labels) [-y]
uip tm objectlabel list --project-key <key> [--object-ids <uuid...>] [--label-types <types...>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm objectlabel get --label-id <uuid>
uip tm objectlabel add --object-ids <uuid...> --labels <name...> [--label-type <type>] [--remove-other-labels]
uip tm objectlabel remove --object-ids <uuid...> (--labels <name...> | --remove-all-labels) [-y]
All verbs honor the global options and the standard exit codes. Every verb accepts -t, --tenant <name> and --log-level <level> (default Information).
uip tm objectlabel list
List label assignments, optionally scoped to specific objects.
Arguments
None.
Options
--project-key <key>(required) — owning project.--object-ids <uuid...>— space-separated object UUIDs to filter by. Optional; omit to list across all objects in the project.--label-types <types...>— space-separated label types to filter by.--filter <text>— free-text search over label names.--sort-by <expr>— sort expression (field name, optionally suffixed with:ascor:desc).--limit <n>— page size. Defaults to50.--offset <n>— results to skip. Defaults to0.
Example
uip tm objectlabel list \
--project-key DEMO \
--object-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001
uip tm objectlabel list \
--project-key DEMO \
--object-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001
Data shape
{
"Code": "ObjectLabelList",
"Data": [
{
"LabelId": "c3d4e5f6-0000-0000-0000-000000000001",
"ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
"Label": "smoke",
"LabelType": "Tag"
}
]
}
{
"Code": "ObjectLabelList",
"Data": [
{
"LabelId": "c3d4e5f6-0000-0000-0000-000000000001",
"ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
"Label": "smoke",
"LabelType": "Tag"
}
]
}
uip tm objectlabel get
Get a single label assignment by its assignment UUID.
Arguments
None.
Options
--label-id <uuid>(required) — UUID of the label assignment (theLabelIdreturned byobjectlabel list). This is the assignment record UUID, not a label name.
Example
uip tm objectlabel get \
--label-id c3d4e5f6-0000-0000-0000-000000000001
uip tm objectlabel get \
--label-id c3d4e5f6-0000-0000-0000-000000000001
Data shape
{
"Code": "ObjectLabelGet",
"Data": {
"LabelId": "c3d4e5f6-0000-0000-0000-000000000001",
"ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
"Label": "smoke",
"LabelType": "Tag"
}
}
{
"Code": "ObjectLabelGet",
"Data": {
"LabelId": "c3d4e5f6-0000-0000-0000-000000000001",
"ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
"Label": "smoke",
"LabelType": "Tag"
}
}
uip tm objectlabel add
Add one or more labels to one or more objects.
Arguments
None.
Options
--object-ids <uuid...>(required) — space-separated object UUIDs to apply the labels to.--labels <name...>(required) — space-separated label names to add.--label-type <type>— label type classification. Optional.--remove-other-labels— remove any existing labels on the specified objects before adding the new ones. Optional.
Example
uip tm objectlabel add \
--object-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001 \
--labels smoke regression \
--label-type Tag
uip tm objectlabel add \
--object-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001 \
--labels smoke regression \
--label-type Tag
Data shape
{
"Code": "ObjectLabelAdd",
"Data": {
"Added": 4,
"Result": "Added"
}
}
{
"Code": "ObjectLabelAdd",
"Data": {
"Added": 4,
"Result": "Added"
}
}
uip tm objectlabel remove
Remove labels from one or more objects. Supply either --labels to remove specific labels, or --remove-all-labels to remove every label from the specified objects.
Arguments
None.
Options
--object-ids <uuid...>(required) — space-separated object UUIDs.--labels <name...>— space-separated label names to remove. Mutually exclusive with--remove-all-labels.--remove-all-labels— remove all labels from the specified objects. Mutually exclusive with--labels.-y, --yes— skip the confirmation prompt.
Examples
# remove specific labels
uip tm objectlabel remove \
--object-ids a1b2c3d4-0000-0000-0000-000000000001 \
--labels smoke \
--yes
# remove all labels
uip tm objectlabel remove \
--object-ids a1b2c3d4-0000-0000-0000-000000000001 \
--remove-all-labels \
--yes
# remove specific labels
uip tm objectlabel remove \
--object-ids a1b2c3d4-0000-0000-0000-000000000001 \
--labels smoke \
--yes
# remove all labels
uip tm objectlabel remove \
--object-ids a1b2c3d4-0000-0000-0000-000000000001 \
--remove-all-labels \
--yes
Data shape
{
"Code": "ObjectLabelRemove",
"Data": {
"Removed": 1,
"Result": "Removed"
}
}
{
"Code": "ObjectLabelRemove",
"Data": {
"Removed": 1,
"Result": "Removed"
}
}
Related
- requirements — search requirements by label with
requirements list --labels <label...>. - customfield — custom field definitions can use labels.