カスタムフィールド

要件システムポータルのカスタムフィールド - API ドキュメント

はじめに

要件とシステム ポータルでは、カスタム フィールドを使用することで、要件やテスト実行に関連付けられた追加フィールド を作成し、プラットフォームの機能を拡張することができます。こ れ ら の フ ィ ール ド には、 日付、 テ キ ス ト 、 選択肢な ど 、 さ ま ざ ま な種類のデー タ を格納で き ます。この API ドキュメントでは、カスタム フィールドとそのオプションをプログラムで作成、更新、管理する手順について説明します。

カスタム フィールドの定義

要件システム・ポータルのカスタム・フィールドは /data/custom-field/エンドポイントを使用して、以下の構文で作成できます：

CustomField{
  "projects"：[uniqueItems: true integer]、
  "target_content_type": integer、
  "name": 文字列、
  "type": integer、
  "multi": boolean
}

• projects:カスタムフィールドが利用可能であるべきプロジェクトの一意な識別子のリスト。

• target_content_type:カスタム フィールドの対象コンテンツ タイプ。要件には 120、テスト実行には 291 を使用します。

• name:カスタム フィールドの名前。

• type:Textには0、Selectionには1、Dateには2を使用する。

• multi:Selectionタイプを定義する際、複数選択の場合はtrueを設定する。

カスタム・フィールドの作成

カスタムフィールドを作成するには、エンドポイントのPUTメソッドを使用します。 /data/custom-field/.例えば

{
  "プロジェクト"：[136],
  "target_content_type"：120,
  "name"：「新しいセレクション・カラム
  「タイプ"：1
}

カスタムフィールドオプションの定義

Selection型のカスタムフィールドを作成する際には、以下のモデルを持つ /data/custom-field-options/エンドポイントを使用して利用可能なオプションを定義する必要があります：

CustomFieldOption{
  "custom_field": integer、
  "titlelename": 文字列、
  "position": 数字
}

• custom_field:オプションを作成するカスタムフィールドの一意な識別子。

• titlename:オプションの名前。

• position:オプション・リストにおけるオプションの位置を定義するオプション・フィールド。

カスタムフィールドオプションの作成

カスタムフィールドオプションを作成するには、エンドポイントのPUTメソッドを使います。 /data/custom-field-options/.例えば

{
  "custom_field"：58,
  "name"："新しいオプション"
}

カスタムフィールドへのデータ追加

カスタムフィールドにデータを追加するには、以下のモデルで /data/custom-field-row/エンドポイントを使います：

CustomFieldRow{
  "referenced_object_id": integer、
  "custom_field": integer、
  "value": 文字列
}

• referenced_object_id:デー タ が属す る オブジ ェ ク ト （要件ま たはテ ス ト ラ ン） の一意な識別子。

• custom_field:デー タ が追加 さ れ る カ ス タ ム フ ィ ール ド の一意な識別子。

• value:追加するデータ。Textの場合はフリーテキスト文字列を、Single Selectionの場合はオプションIDを、Multiple Selectionの場合はオプションIDのリストを、Dateの場合は文字列形式の日付を使用します。

カスタムフィールドへのデータ追加 - 初回入力

指定したオブジェクトのカスタムフィールドに初めてデータを入力するには、エンドポイントに POST メソッドを使用します。 /data/custom-field-row/bulk-create/.例えば

{
  "referenced_object_id"：33803,
  "custom_field"：58,
  値": 29
}

カスタムフィールドのデータ更新

指定したオブジェクトのカスタムフィールドの既存のデータを更新するには、エンドポイントのPOSTメソッドを使用します。 /data/custom-field-row/bulk-update/.例えば

{
  "614":{
    "値": 30
  }
}

カスタムフィールドからデータを削除する

指定したカスタム・フィールドとオブジェクトに関連付けられたデータを削除するには、同じ一括更新メソッドを "value": null.例えば

{
  "614":{
    "値": null
  }
}

結論

要件システムポータルのカスタム フィールドを使用すると、プラットフォームの機能を強化し、特定のプロジェクト ニーズに合わせてカスタマイズできます。提供されている API エンドポイントを使用して、カスタム フィールドの作成、オプションの定義、データの追加をプログラムで行うことができます。