UIP TM カスタム フィールド

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

• customfield — フィールド定義自体の管理 (リスト、取得、作成、更新、削除)
• customfield label — オブジェクトに適用されるラベルの割り当てを管理します
• customfield value — フィールドに許可されている値を管理します。

重要:

フィールド定義のプライマリ識別子は --field-idです。ラベルコマンドと値コマンドのスコープは、--object-id、--label-id、または --value-idと組み合わせた--object-typeです。このフラグ --customfield-id は v1.196 には存在しません。

概要

# 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 --object-type <type> (--field-id <uuid> | --name <name>)
uip tm customfield create --project-key <key> --name <name> --object-type <type> --data-type <type> [--scope-list <list>] [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --object-type <type> (--field-id <uuid> | --name <name>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <list>]
uip tm customfield delete --object-type <type> (--field-ids <uuid...> | --name <name>) [-y]

# Labels
uip tm customfield label get --object-type <type> --label-id <uuid>
uip tm customfield label list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield label create --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <values...>
uip tm customfield label remove --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <values...> | --remove-all-values)

# Values
uip tm customfield value list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield value get --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --object-type <type> --name <name> --object-id <uuid> --data-type <type> --value <value>
uip tm customfield value update --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) --value <value> [--clear]
uip tm customfield value delete --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [-y]

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

---

フィールド定義コマンド

uip tm customfield list

プロジェクト内のカスタム フィールドの定義のリストを取得します。--project-keyは必須です。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --object-types <types...> — フィルター処理に使用するスペースで区切られたオブジェクトの種類。
• --data-types <types...> — フィルター処理に使用するスペースで区切られたデータ型。
• --name <name> — 正確なフィールド名でフィルター処理します。
• --filter <text> — フリーテキスト検索。
• --sort-by <expr> — 式を並べ替えます。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

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

データシェイプ

{
  "Code": "CustomFieldList",
  "Data": [
    {
      "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "ObjectType": "TestCase",
      "DataType": "String"
    }
  ]
}

---

uip tm customfield get

カスタム フィールドの定義を 1 つ取得します。

オプション

• --object-type <type> (必須) — フィールドが属するオブジェクトの種類です。
• --field-id <uuid> — フィールド UUID。--nameと相互に排他的です。
• --name <name> — フィールド名。--field-idと相互に排他的です。

例

uip tm customfield get \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "CustomFieldGet",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}

---

uip tm customfield create

カスタム フィールド定義を新規作成します。

オプション

• --project-key <key> (必須) — プロジェクトを所有しています。
• --name <name> (必須) — フィールド名。
• --object-type <type> (必須) — フィールドのアタッチ先のオブジェクトの種類 ( TestCase、 TestSetなど) です。
• --data-type <type> (必須) — フィールドのデータ型 ( String、 Integer、 Booleanなど) です。
• --scope-list <list> — フィールドのスコープの制限。
• --description <text> — フィールドの説明。
• --default-value <value> — 新しいオブジェクトの既定値です。
• --value-hints <hints> — フィールドに対して許可される値のヒントまたは列挙。

例

uip tm customfield create \
  --project-key DEMO \
  --name "Priority" \
  --object-type TestCase \
  --data-type String \
  --value-hints "Low,Medium,High"

データシェイプ

{
  "Code": "CustomFieldCreate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}

---

uip tm customfield の更新

既存のカスタム フィールドの定義を更新します。

オプション

• --object-type <type> (必須) — フィールドが属するオブジェクトの種類です。
• --field-id <uuid> — フィールド UUID。--nameと相互に排他的です。
• --name <name> — フィールド名 (ルックアップ用)。--field-idと相互に排他的です。
• --rename-to <name> — フィールドの新しい名前。
• --description <text> — 新しい説明。
• --default-value <value> — 新しいデフォルト値。
• --value-hints <hints> — 新しい許容値のヒント。
• --scope-list <list> — 新しいスコープの制限。

例

uip tm customfield update \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to "Severity"

データシェイプ

{
  "Code": "CustomFieldUpdate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}

---

uip tm customfield delete

1 つまたは複数のカスタム フィールド定義を削除します。

オプション

• --object-type <type> (必須) — フィールドが属するオブジェクトの種類です。
• --field-ids <uuid...> — 削除するスペース区切りのフィールドUUID。--nameと相互に排他的です。
• --name <name> — 削除するフィールドの名前です。--field-idsと相互に排他的です。
• -y, --yes — 確認プロンプトをスキップします。

例

uip tm customfield delete \
  --object-type TestCase \
  --field-ids c1b2c3d4-0000-0000-0000-000000000001 \
  --yes

データシェイプ

{
  "Code": "CustomFieldDelete",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

---

ラベル コマンド

uip tm customfield label get

UUID で 1 つのラベルの割り当てを取得します。

オプション

• --object-type <type> (必須) — ラベルが属するオブジェクトの種類です。
• --label-id <uuid> (必須) — ラベル割り当ての UUID です (ラベル名ではありません)。

例

uip tm customfield label get \
  --object-type TestCase \
  --label-id l1b2c3d4-0000-0000-0000-000000000001

データシェイプ

{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Label": "Priority"
  }
}

---

uip tm customfield ラベル リスト

オブジェクト タイプのラベルの割り当てのリストを一覧表示し、必要に応じて特定のオブジェクトに絞り込みます。

オプション

• --object-type <type> (必須) — ラベルのリストを取得するオブジェクトの種類です。
• --object-id <uuid> — 特定のオブジェクトUUIDにフィルタします。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

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

データシェイプ

{
  "Code": "CustomFieldLabelList",
  "Data": [
    {
      "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "Label": "Priority"
    }
  ]
}

---

uip tm customfield label create

オブジェクトに新しいラベルを作成します。

オプション

• --object-type <type> (必須) — ラベルの添付先のオブジェクトの種類。
• --object-id <uuid> (必須) — ラベル付けするオブジェクトの UUID。
• --values <json> (必須) — 適用するラベル値の JSON 配列です。

例

uip tm customfield label create \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '[{"name":"Priority","value":"High"}]'

データシェイプ

{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Created"
  }
}

---

uip tm customfield label add

名前付きカスタム フィールドの 1 つ以上のオブジェクトにラベル値を追加します。

オプション

• --object-type <type> (必須) — オブジェクトタイプ。
• --custom-field-name <name> (必須) — カスタム フィールドの名前。
• --object-ids <uuid...> (必須) — ラベルを適用するスペースで区切られたオブジェクトUUID。
• --values <values...> (必須) — 追加するスペース区切りのラベル値です。

例

uip tm customfield label add \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High

データシェイプ

{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "Result": "Added"
  }
}

---

uip tm customfield label remove

名前付きカスタム フィールドの 1 つ以上のオブジェクトからラベル値を削除します。

オプション

• --object-type <type> (必須) — オブジェクトタイプ。
• --custom-field-name <name> (必須) — カスタム フィールドの名前。
• --object-ids <uuid...> (必須) — スペースで区切られたオブジェクト UUID。
• --values <values...> — スペースで区切られたラベル値を削除します。
• --remove-all-values - 指定したオブジェクトからこのフィールドのすべてのラベル値を削除します。--valuesと相互に排他的です。

例

uip tm customfield label remove \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High

データシェイプ

{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "Result": "Removed"
  }
}

---

値コマンド

uip tm customfield 値リスト

オブジェクトの種類に対してカスタム フィールド値のリストを表示します。必要に応じて、特定のオブジェクトに絞り込みます。

オプション

• --object-type <type> (必須) — オブジェクトタイプ。
• --object-id <uuid> — 特定のオブジェクトUUIDにフィルタします。
• --limit <n> — ページ サイズ。既定値は [ 50です。
• --offset <n> — スキップする結果。既定値は [ 0です。

例

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

データシェイプ

{
  "Code": "CustomFieldValueList",
  "Data": [
    {
      "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High"
    }
  ]
}

---

uip tm customfield value get

カスタム フィールドの値を 1 つ取得します。

オプション

• --object-type <type> (必須) — オブジェクトタイプ。
• --value-id <uuid> — 値 UUID。--name + --object-idと相互に排他的です。
• --name <name> — フィールド名。--object-idと併用します。
• --object-id <uuid> — オブジェクト UUID。--nameと併用します。

例

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

データシェイプ

{
  "Code": "CustomFieldValueGet",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}

---

uip tm customfield value create

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

オプション

• --object-type <type> (必須) — オブジェクトタイプ。
• --name <name> (必須) — カスタム フィールド名。
• --object-id <uuid> (必須) — オブジェクト UUID。
• --data-type <type> (必須): 値のデータ型 ( String、 Integerなど) です。
• --value <value> (必須) — 設定する値です。

例

uip tm customfield value create \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type String \
  --value High

データシェイプ

{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}

---

uip tm customfield 値の更新

既存のカスタム フィールドの値を更新します。

オプション

• --object-type <type> (必須) — オブジェクトタイプ。
• --value-id <uuid> — 値 UUID。--name + --object-idと相互に排他的です。
• --name <name> — フィールド名。--object-idと併用します。
• --object-id <uuid> — オブジェクト UUID。--nameと併用します。
• --value <value> (必須) — 新しい値。
• --clear — 値を設定するのではなく、クリアします。

例

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

データシェイプ

{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Value": "Critical",
    "Result": "Updated"
  }
}

---

uip tm customfield 値の削除

カスタム フィールドの値を削除します。

オプション

• --object-type <type> (必須) — オブジェクトタイプ。
• --value-id <uuid> — 値 UUID。--name + --object-idと相互に排他的です。
• --name <name> — フィールド名。--object-idと併用します。
• --object-id <uuid> — オブジェクト UUID。--nameと併用します。
• -y, --yes — 確認プロンプトをスキップします。

例

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

データシェイプ

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

---

関連

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

参照

• Test Manager の概要
• 認証