uip tm customfield

「uip tm customfield」の構文とオプション。Test Manager プロジェクトのカスタム フィールドの定義、ラベル行、および値の行を管理します。

uip tm customfield は、Test Manager プロジェクトのカスタム フィールドの定義を管理します。カスタム フィールドは、プロジェクト固有のメタデータによって要件、テスト ケース、テスト セットを拡張します。このコマンド グループには、次の 3 つのサブグループがあります。

• customfield — フィールド定義自体の管理 (リスト、取得、作成、更新、削除)
• customfield label — ラベル型のフィールドの行を管理します (オブジェクトごとに、フィールド名から 1 つ以上の文字列値への JSON マップ)
• customfield value — Text 型フィールドの行を管理します (オブジェクトごとに 1 つの文字列値)

重要:

フィールド定義のプライマリ識別子は --field-idです。ラベル行と値行は、 --label-id / --value-id、または自然キー --object-type + --name + --object-idで識別されます。フラグ --customfield-id が存在しません。

概要

# Field definitions
uip tm customfield list --project-key <key> [--object-types <types...>] [--data-types <types...>] [--name <name>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield get --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>)
uip tm customfield create --project-key <key> --name <name> --data-type <Text|Label> (--object-type <type> | --scope-list <types...>) [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <types...>]
uip tm customfield delete --project-key <key> (--field-ids <uuid...> | --name <name> --object-type <type>) [-y]

# Labels
uip tm customfield label get --project-key <key> --object-type <type> --label-id <uuid>
uip tm customfield label list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield label create --project-key <key> --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <value...> [--replace-existing-values]
uip tm customfield label remove --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <value...> | --remove-all-values) [-y]

# Values
uip tm customfield value list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield value get --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --project-key <key> --object-type <type> --name <name> --object-id <uuid> --data-type <Text|Label> [--value <text>]
uip tm customfield value update --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [--data-type <Text|Label>] (--value <text> | --clear)
uip tm customfield value delete --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [-y]

すべての動詞は、 グローバル オプション と標準の 終了コードを尊重します。すべての動詞は、 --log-level <level> (既定 Information) と -t, --tenant <name> (既定では認証済みテナント) を受け入れます。

注:

-t, --tenant 、これは通常の表示オプションです。

--object-type (および --object-types/--scope-list (可変異数) は、 TestCase、または TestSetRequirementのみを受け付けます。--data-type (および --data-types) は Text または Label のみを受け付けます。 String、 Integer、 Boolean のデータ型はありません。

---

フィールド定義コマンド

uip tm customfield list

プロジェクト内のカスタム フィールドの定義のリストを表示します。--project-keyが必要です。その他のフィルターはすべて任意です。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-types <types...> — フィルター処理に使用するスペースで区切られたオブジェクトの種類 ( Requirement、 TestCase、 TestSetです。
• --data-types <types...> — フィルター処理に使用するスペース区切りのデータ型 ( Text、 Labelです。
• --name <name> — 名前の完全一致 (クライアント側のフィルター。フィールドが定義されたオブジェクトの種類ごとに 1 つの行を返します)。
• --filter <text> — 定義フィールド全体にわたるサーバー側の部分文字列検索。
• --sort-by <expr> — 並べ替え式 (例: name asc)。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

uip tm customfield list \
  --project-key DEMO \
  --object-types TestCase

データシェイプ

{
  "Code": "CustomFieldDefinitionsList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "Name": "Priority",
      "Description": "Test priority",
      "DefaultValue": "Medium",
      "ValueHints": "",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "ScopeList": ["TestCase"]
    }
  ]
}

---

uip tm customfield get

単一のカスタム フィールドの定義を取得します。--field-id、または --name + --object-typeで識別します。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --field-id <uuid> — フィールド UUID です。
• --name <name> — フィールド名。--object-typeと併用します。
• --object-type <type> — フィールドが属するオブジェクトの種類 ( Requirement、 TestCase、 TestSetです。と一緒に使用 --name。

例

uip tm customfield get \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "CustomFieldDefinitionGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}

---

uip tm customfield create

新しいカスタム フィールドの定義を作成します。1 つのスコープに対して --object-type を指定するか、複数のスコープに対して --scope-list を指定します。この 2 つは相互に排他的であり、1 つは必須です。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --name <name> (必須) — フィールド名。
• --data-type <type> (必須) — Text または Labelです。
• --object-type <type> — 単一のスコープ: Requirement、 TestCase、 TestSet。--scope-listと相互に排他的です。
• --scope-list <types...> — マルチオブジェクト スコープ (スペース区切り): Requirement、 TestCase、 TestSetです。--object-typeと相互に排他的です。
• --description <text> — フィールドの説明。
• --default-value <text> — フィールドの型の既存のすべてのオブジェクトにシードされる既定値です。
• --value-hints <text> — フィールドの横に表示される UI ヒント テキストです。

例

uip tm customfield create \
  --project-key DEMO \
  --name Priority \
  --data-type Text \
  --object-type TestCase \
  --description "Test priority" \
  --default-value Medium

データシェイプ

{
  "Code": "CustomFieldDefinitionCreate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}

---

uip tm customfield update

既存のカスタム フィールドの定義を更新します。--field-id、または --name + --object-typeで識別します。未指定のフィールドでは現在の値が保持されます。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --field-id <uuid> — フィールド UUID です。
• --name <name> — フィールド名 (検索用)。と一緒に使用 --object-type。
• --object-type <type> — フィールドが属するオブジェクトの種類です。と一緒に使用 --name。
• --rename-to <name> — フィールドの新しい名前。
• --description <text> — 新しい説明。
• --default-value <text> — 新しいデフォルト値。
• --value-hints <text> — 新しい UI ヒント テキストです。
• --scope-list <types...> — 新しいマルチオブジェクト スコープ (スペース区切り)。

例

uip tm customfield update \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to Severity

データシェイプ

{
  "Code": "CustomFieldDefinitionUpdate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}

---

uip tm customfield delete

1 つ以上のカスタム フィールドの定義を削除します。--field-ids (1 つまたは複数の UUID) または --name + --object-type (単一、自然キーによる) で識別します。カスケードなしの物理削除 — 孤立したラベル/値の行はクリーンアップ されません 。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --field-ids <uuid...> — 削除するフィールドの UUID です。
• --name <name> — フィールド名 ( --object-typeとともに使用)。
• --object-type <type> — フィールドが属するオブジェクトの種類です ( とともに使用 --name)。
• -y, --yes — この元に戻せない操作を確定します。必須 — CLI はプロンプトを表示しません。

例

uip tm customfield delete \
  --project-key DEMO \
  --field-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --yes

データシェイプ

{
  "Code": "CustomFieldDefinitionsDelete",
  "Data": { "Passed": 1, "Failed": 0 }
}

Passed/Failed はカウントであり、ID ごとの詳細ではありません。応答は、どの UUID が失敗したかは反映されません。--field-idsを介して渡された不明な UUID は一括エンドポイントに転送され、事前に拒否されるのではなく、Failedとしてカウントされます。

---

ラベル コマンド

ラベル行は、オブジェクト インスタンスごとに 1 つの JSON オブジェクトを持ち、カスタム フィールド名を文字列値の配列 ({"Priority":["High"],"Tags":["smoke","critical"]}) にマッピングします。

uip tm customfield label get

カスタム フィールドのラベルの行を --label-idで取得します。代わりにオブジェクトで検索するには、 customfield label list --object-id <uuid> を使用します (1 要素配列と同じ行を返します)。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — ラベルが属するオブジェクトの種類 ( Requirement、 TestCase、 TestSetです。
• --label-id <uuid> (必須) — ラベル行の UUID です (ラベル名ではありません)。

例

uip tm customfield label get \
  --project-key DEMO \
  --object-type TestCase \
  --label-id f1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "[e-mail]",
    "Updated": "2025-01-02T00:00:00Z",
    "UpdatedBy": "[e-mail]"
  }
}

---

uip tm customfield label list

オブジェクトの種類のラベル行のリストを取得します。必要に応じて、特定のオブジェクトに絞り込みます。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — ラベルのリストを取得するオブジェクトの種類です。
• --object-id <uuid> — 特定のオブジェクトUUIDにフィルタします。
• --filter <text> — ラベル行を値で検索します。
• --sort-by <expr> — 式を並べ替えます。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

uip tm customfield label list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "CustomFieldLabelsList",
  "Data": [
    {
      "Id": "f1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
      "Created": "2025-01-01T00:00:00Z",
      "CreatedBy": "[e-mail]",
      "Updated": "2025-01-02T00:00:00Z",
      "UpdatedBy": "[e-mail]"
    }
  ]
}

---

uip tm customfield label create

オブジェクトのラベル値を更新または挿入します。バックエンドは、新しいフィールド名キーを同じオブジェクトの既存の行にマージします。行全体を置き換えることはありません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — ラベルを添付するオブジェクトの種類です。
• --object-id <uuid> (必須) — ラベル付けするオブジェクトの UUID。
• --values <json> (必須) — フィールド名を文字列配列にマッピングする空ではない JSON オブジェクト です (例: {"Priority":["High"],"Tags":["smoke","critical"]})。JSON 配列、またはキーごとの文字列の配列ではない値は、クライアント側で拒否されます。

例

uip tm customfield label create \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '{"Priority":["High"],"Tags":["smoke"]}'

データシェイプ

{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "[e-mail]",
    "Updated": "2025-01-01T00:00:00Z",
    "UpdatedBy": "[e-mail]"
  }
}

---

uip tm customfield label add

1 回の呼び出しで、複数のオブジェクトにまたがる 1 つの名前付きカスタム フィールドにラベル値を追加します。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — オブジェクトタイプ。
• --custom-field-name <name> (必須) — このオブジェクトの種類の既存のカスタム フィールド定義の名前です。
• --object-ids <uuid...> (必須) — ラベルを適用するスペースで区切られたオブジェクトUUID。
• --values <value...> (必須) — 追加するスペース区切りのラベル値です。
• --replace-existing-values — 結合ではなく既存の値を置き換えます (既定値: 結合)。

例

uip tm customfield label add \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values High Critical

データシェイプ

{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Added"
  }
}

---

uip tm customfield label remove

複数のオブジェクトにまたがる 1 つの名前付きカスタム フィールドからラベル値を削除します。これは 破壊的な 操作であり、 -y, --yesが必要です。CLI はプロンプトを表示しません。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — オブジェクトタイプ。
• --custom-field-name <name> (必須) — カスタム フィールドの名前。
• --object-ids <uuid...> (必須) — スペースで区切られたオブジェクト UUID。
• --values <value...> — 削除するスペース区切りのラベル値です。--remove-all-valuesが設定されていない限り必須です。
• --remove-all-values — リストされたオブジェクトのこのフィールドのすべての値をクリアします。--valuesと相互に排他的です。
• -y, --yes — この元に戻せない操作を確定します。必須 — CLI はプロンプトを表示しません。

例

uip tm customfield label remove \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values Critical \
  --yes

データシェイプ

{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Removed"
  }
}

---

値コマンド

値の行は、オブジェクトごとに 1 つの Text 型の値を格納します。

uip tm customfield value list

オブジェクトの種類のカスタム フィールド値のリストを表示します。--object-id指定しない限り、結果は空です。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — オブジェクトタイプ。
• --object-id <uuid> — 値をリストするオブジェクト UUID です。実際には必須です。省略すると結果は空になります。
• --filter <text> — 内容で値を検索します。
• --sort-by <expr> — 式を並べ替えます。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

uip tm customfield value list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "CustomFieldValuesList",
  "Data": [
    {
      "Id": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "Updated": "2025-01-02T00:00:00Z"
    }
  ]
}

---

uip tm customfield value get

単一のカスタム フィールド値行を取得します。--value-id、または --name + --object-idで識別します。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — オブジェクトタイプ。
• --value-id <uuid> — 値行 UUID。
• --name <name> — フィールド名。--object-idと併用します。
• --object-id <uuid> — オブジェクト UUID。--nameと併用します。

例

uip tm customfield value get \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "CustomFieldValueGet",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}

---

uip tm customfield value create

オブジェクトにカスタム フィールド値の行を作成します。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — オブジェクトタイプ。
• --name <name> (必須) — カスタム フィールド名です (既存の定義と一致する必要があります)。
• --object-id <uuid> (必須) — この値が接続されるオブジェクト UUID です。
• --data-type <type> (必須) — Text または Label (定義に一致する必要があります)。
• --value <text> — 価値のコンテンツ。任意 — 空の行を作成する場合は省略します。

例

uip tm customfield value create \
  --project-key DEMO \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type Text \
  --value High

データシェイプ

{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}

---

uip tm customfield value update

既存のカスタム フィールドの値の行を更新します。--value-id、または --name + --object-idで識別します。--clearが合格しない限り、--valueが必要です。

注:

空の --value があると、行のフィールド名が定義にマップされなくなった場合、行が更新されず、削除される可能性があります。その意図を認める --clear を渡します。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — オブジェクトタイプ。
• --value-id <uuid> — 値行 UUID。
• --name <name> — フィールド名。--object-idと併用します。
• --object-id <uuid> — オブジェクト UUID。--nameと併用します。
• --data-type <type> — Text または Labelです。既定では、行の現在のデータ型です。
• --value <text> — 新しい値です。--clearが合格しない限り必須です。
• --clear — 空の --value によって行が削除される可能性があることを確認します。

例

uip tm customfield value update \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --value Critical

データシェイプ

{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Updated"
  }
}

---

uip tm customfield value delete

カスタム フィールドの値の行を削除します。--value-id、または --name + --object-idで識別します。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-type <type> (必須) — オブジェクトタイプ。
• --value-id <uuid> — 値行 UUID。
• --name <name> — フィールド名。--object-idと併用します。
• --object-id <uuid> — オブジェクト UUID。--nameと併用します。
• -y, --yes — この元に戻せない操作を確定します。必須 — CLI はプロンプトを表示しません。

例

uip tm customfield value delete \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --yes

データシェイプ

{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

---

関連

• 要件 — 要件にはカスタム フィールド値を含めることができます。
• テスト ケース — テスト ケースにはカスタム フィールド値を含めることができます。

参照

• Test Manager の概要