UiPath CLI user guide

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]

Arguments​

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 :asc or :desc).
• --limit <n> — page size. Defaults to 50.
• --offset <n> — results to skip. Defaults to 0.

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"
    }
  ]
}

Arguments​

Options​

• --label-id <uuid> (required) — UUID of the label assignment (the LabelId returned by objectlabel 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"
  }
}

Arguments​

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"
  }
}

Arguments​

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"
  }
}

• requirement — search requirements by label with requirement search-by-label.
• customfield — custom field definitions can use labels.

• Test Manager overview
• Authentication