uip tm objectlabel

「uip tm objectlabel」の構文とオプション - テスト ケースや要件など、Test Manager オブジェクトに付加されたラベルを管理します。

uip tm objectlabel は、Test Manager オブジェクト (要件、テスト ケース、テスト セット、テスト実行、テスト ケースのログ) に添付されるラベルを管理します。ラベルは自由形式の文字列で、フィルター処理や検索のためにオブジェクトにタグを付けたりグループ化したりするために使用します。

重要:

Every verb in this group needs a project (--project-id or --project-key) and --object-type, including get. list, add, and remove take the plural, space-separated --object-ids; get takes a single --object-id. --labels is plural; there is no --label flag.

概要

uip tm objectlabel list (--project-id <id> | --project-key <key>) --object-type <type> [--object-ids <uuid...>] [--label-types <types...>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm objectlabel get (--project-id <id> | --project-key <key>) --object-type <type> --object-id <uuid>
uip tm objectlabel add (--project-id <id> | --project-key <key>) --object-type <type> --object-ids <uuid...> --labels <name...> [--label-type <type>] [--remove-other-labels]
uip tm objectlabel remove (--project-id <id> | --project-key <key>) --object-type <type> --object-ids <uuid...> (--labels <name...> | --remove-all-labels) --yes

All verbs honor the global options and the standard exit codes. Every verb accepts --log-level <level> (default Information). Every verb also accepts -t, --tenant <name> to run against a tenant other than the one your uip login session selected. It defaults to the session's tenant.

When you pass both --project-id and --project-key, --project-id wins. If you pass neither, the command fails with ErrorCode: invalid_argument.

--object-type accepts Requirement, TestCase, TestSet, TestExecution, or TestCaseLog. --label-types on list accepts the wire-form values userLabel, systemLabel, internalLabel, and generatedLabel; --label-type on add accepts only userLabel. Both take the wire form, not the PascalCase forms used elsewhere in this CLI.

uip tm objectlabel list

List distinct label names in use for one object type (paginated). This does not return label assignment rows — use get for the labels on one object.

引数

設定はありません。

オプション

• --project-id <id> — Test Manager project ID. Wins if --project-key is also given.
• --project-key <key> — Test Manager project key (for example, DEMO). Ignored if --project-id is also given.
• --object-type <type> (必須) — ラベルのリストを取得するオブジェクトの種類です。
• --object-ids <uuid...> — これらのオブジェクトに割り当てられているラベル (スペース区切り) に制限します。オブジェクトの種類全体を検索する場合は省略します。
• --label-types <type...> — label types to include (userLabel, systemLabel, internalLabel, generatedLabel, space-separated). The server always returns systemLabel, userLabel, and generatedLabel names and adds the types passed here, so this flag widens the result rather than narrowing it.
• --filter <text> — ラベル名を照合するためのプレフィックスです (サーバー側の StartsWith、一般的な部分文字列検索ではありません)。
• --sort-by <expr> — 並べ替え式 (例: name asc)。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

uip tm objectlabel list \
  --project-key DEMO \
  --object-type TestCase \
  --filter smo \
  --limit 50

データシェイプ

{
  "Code": "ObjectLabelsList",
  "Data": [
    { "Name": "smoke" },
    { "Name": "smoke-test" }
  ]
}

Each row is only { "Name": "<label>" } — list returns no Id, ObjectId, or LabelType. To see the labels on one object with their ids and label types, use objectlabel get.

uip tm objectlabel get

Get the visible labels on one object — user, system, and generated labels — including label ids and label types. Internal labels are not returned. list returns distinct label names for an object type; get returns the full assignment rows for a single object.

引数

設定はありません。

オプション

• --project-id <id> — Test Manager project ID. Wins if --project-key is also given.
• --project-key <key> — Test Manager project key (for example, DEMO). Ignored if --project-id is also given.
• --object-type <type> (必須) — ラベルが属するオブジェクトの種類です。
• --object-id <uuid> (required) — object UUID, for example the Id from uip tm testcases list (or the list verb matching --object-type).

例

uip tm objectlabel get \
  --project-key DEMO \
  --object-type TestCase \
  --object-id f9e8d7c6-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "ObjectLabelGet",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "a1b2c3d4-0000-0000-0000-000000000009",
      "ObjectId": "f9e8d7c6-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "Name": "smoke",
      "Description": "",
      "LabelType": "UserLabel"
    }
  ]
}

Data is an array with one row per label on the object, and an empty array when the object has no visible labels. LabelType is PascalCase (UserLabel, SystemLabel, GeneratedLabel) even though the --label-type/--label-types input flags take the camelCase wire form.

uip tm objectlabel add

ラベルを 1 つ以上のオブジェクトに追加します。--label-typeが合格するかどうかによって 2 つの異なる動作があります。

• Without --label-type (default): a single bulk-add call across all objects and labels. Pass --remove-other-labels to make this an authoritative set — after adding, any non-system labels on these objects that are not in --labels are deleted.
• With --label-type userLabel: each label is assigned individually (one call per object × label pair). --remove-other-labels is ignored in this mode.

引数

設定はありません。

オプション

• --project-id <id> — Test Manager project ID. Wins if --project-key is also given.
• --project-key <key> — Test Manager project key (for example, DEMO). Ignored if --project-id is also given.
• --object-type <type> (必須) — オブジェクトタイプ。
• --object-ids <uuid...> (必須) — ラベルを適用するスペースで区切られたオブジェクトUUID。
• --labels <name...> (必須) — 追加するスペース区切りのラベル名です。
• --label-type <type> — label type. Only userLabel is accepted: objectlabel remove cannot detach a system label, so the CLI writes user labels only. When set, switches to the per-pair assign path described above.
• --remove-other-labels — 追加後、これらのオブジェクトの に存在しない非システム ラベルをすべて削除 --labels。--label-typeが設定されている場合は無視されます。

例

# Bulk add — multiple labels to multiple objects in one call
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels smoke regression

# With an explicit label type — assigns each label individually
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels smoke \
  --label-type userLabel

データシェイプ

{
  "Code": "ObjectLabelsAdd",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 2,
    "Result": "Added"
  }
}

LabelCount counts distinct label names, case-insensitively. When --label-type is passed, the response includes it:

{
  "Code": "ObjectLabelsAdd",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "LabelType": "userLabel",
    "Result": "Added"
  }
}

uip tm objectlabel remove

Remove user and generated labels from up to 100 objects. Pass --labels to remove specific labels, or --remove-all-labels to remove every user and generated label on the listed objects; the two are mutually exclusive, and one is required. Names match case-insensitively. The removal is irreversible and requires -y, --yes.

• System labels are never removed. Matching system label names are reported in SkippedSystemLabels.
• Internal label names, and names of label types the CLI doesn't recognize, are never sent. With --labels, requested internal names are reported in SkippedInternalLabels; with --remove-all-labels, user or generated labels that share a name with an internal label are kept and reported there.
• remove reads the objects' labels before writing — at least two read requests per object, five objects at a time — so it needs read access to the listed objects. If the labels can't be read, or an object carries 500 or more label names, nothing is removed.
• If a removal request fails partway through, the error message lists the labels already removed.

引数

設定はありません。

オプション

• --project-id <id> — Test Manager project ID. Wins if --project-key is also given.
• --project-key <key> — Test Manager project key (for example, DEMO). Ignored if --project-id is also given.
• --object-type <type> (必須) — オブジェクトタイプ。
• --object-ids <uuid...> (required) — space-separated object UUIDs. At most 100 distinct ids per call; duplicates are ignored.
• --labels <name...> — 削除するスペース区切りのラベル名です。--remove-all-labelsが設定されていない限り必須です。
• --remove-all-labels — remove the user and generated labels on the listed objects, except any that share a name with an internal label. System and internal labels are kept, unlike clear-all in the Test Manager UI. Mutually exclusive with --labels.
• -y, --yes (required) — confirms the irreversible operation. The CLI never prompts; without --yes the command returns Result: "Failure" and exits 1.

例

# remove specific labels
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels regression \
  --yes

# remove every user and generated label
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --remove-all-labels \
  --yes

データシェイプ

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "RemovedLabels": ["regression"],
    "Result": "Removed"
  }
}

--remove-all-labels:

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "RemoveAllLabels": true,
    "RemovedLabels": ["regression", "smoke"],
    "SkippedSystemLabels": ["automated"],
    "Result": "AllRemoved"
  }
}

フィールド	説明
ObjectCount	Number of distinct object ids processed.
LabelCount	With --labels, the number of distinct requested names (case-insensitive). Replaced by RemoveAllLabels: true with --remove-all-labels.
RemovedLabels	Label names removed, sorted.
SkippedSystemLabels	System label names that matched and were kept. Omitted when empty.
SkippedInternalLabels	Names kept because they are, or share a name with, an internal label. Omitted when empty.
Result	Removed, AllRemoved (with --remove-all-labels), or Skipped when nothing was removed.

関連

• 要件 — 要件にはオブジェクト ラベルを付けることができます。
• customfield — ラベルの種類のカスタム フィールド値用の別のラベル メカニズム (customfield label) です。 objectlabelの自由形式のタグとは異なります。

参照

• Test Manager の概要