フィールドにアクセスできるかどうか (PUBLIC、PUBLIC_TECH_PREVIEWなど)。

• フィールド名: access_level

ルールがこのフィールドにアクセスできるかどうか。

• フィールド名: accessible_via_business_rules

• 値: Boolean

フィールドがALM Octaneによって自動的に生成されるかどうか。

• フィールド名: auto_generated

• 値: Boolean

フィールドの説明。

• フィールド名:description

フィールドが属するエンティティ。

• フィールド名:entity_name

このフィールドでサポートされているフィーチャーのセット (次のようなもの)。

• non-auditable。標準設定では、フィールドの監査がサポートされています。このフィーチャーがリストされている場合、フィールドは監査のために追跡されません。このフィーチャーは次のようにリストされています。"name": "non-auditable".

• graphable. このフィールドはグラフで使用できます。このフィーチャーは次のようにリストされています。"name": "graphable".

フィールドの期待値のタイプ。

• フィールド名:field_type

使用可能なフィールドタイプについては、フィールドタイプを参照してください。

フィールドをフィルタリングできるかどうか。

• フィールド名:filterable

• 値: Boolean

このフィールドでグループ化できるかどうか。

• フィールド名:groupable

• 値: Boolean

UIに表示される可能性のあるフィールドのラベル。

• Label

• フィールド名:label

API表現に表示されるフィールドの名前。

• フィールド名:name

フィールド選択がない場合にフィールドが標準設定で返されるかどうか。

• フィールド名:returned_by_default

フィールドをクエリで使用できるかどうか。

一部のフィールドは、返される結果が多すぎる場合、意図的に選択できません。

たとえば、重大度によって不具合を照会できます。ただし、重大度と関連するすべての不具合を照会すると、返される結果が多すぎる可能性があります。

• フィールド名:selectable

• 値: Boolean

このフィールドに従ってエンティティを並べ替えることができるかどうか。

• フィールド名:sortable

• 値: Boolean

フィールドが権限によって制御されているかどうか。

• フィールド名:supports_permissions

• 値: Boolean

フィールドがシステム定義かユーザー定義か。

• フィールド名:is_user_defined

• 値: Boolean

フィールドがALM Octaneユーザーインターフェイスに表示されるかどうか。

• フィールド名:visible_in_ui

• 値: Boolean

• ブール値を含むフィールド。

• 値:true /false

“field_type”: “boolean”

• 「日付のみ」を意味する完全な日付と時刻の情報を含むフィールドはサポートされていません。

• 予想される日付形式は次のとおりです。ISO-8601、例:

  • 2018-06-10T10:13:15Z

  • 2018-03-12T16:42:11%2B01:00 (エンコードされた2018-03-12T16:42:11 + 01:00

  • 2018-03-12T16:42:11-01:00

• 日付と時刻はUTCです。

• 作成、更新、フィルタリングの目的で、APIコンシューマーはUTCおよびISO-8601形式を使用する必要があります。

“field_type”: “date_time”

• 整数値を含むフィールド。

• このタイプの値は、-9007199254740991から+9007199254740991の範囲になります。

“field_type”: “integer”

注: すべてのIDフィールドは文字列であり、整数ではありません。

• テキスト値を含むフィールド。

• 通常はHTMLで表されます

“field_type”: “memo”

• 任意の構造を持つフィールド。

• JSONドキュメントで定義されているように、JSONオブジェクトとして表されます。

“field_type”: “object”

• エンティティコレクションを参照するフィールド。

• 値はリンクとして設定されます。リンクは、次のものを含むオブジェクトです。 

  • エンティティタイプ

  • エンティティID

  Example:  

  {

       "id": 1001,

       "type": "defect"

  }

• フィールドfield_typeには、フィールドのタイプが含まれています。参照フィールドの場合: “field_type”: “reference”

• フィールドfield_type_dataには、参照されるタイプに関する情報が含まれています。

• 複数フィールドがtrueに設定されている場合、複数の参照を表すことができます。複数フィールドがtrueに設定されている場合、値は次の形式で期待されます。

  {

      “total_count”: 2,

      “data”: [

          {

              “id”: 1001,

              “type”: “release”

          },

          {

              “id”: 1002,

              “type”: “release”

          }

      ]

  }

  注: POSTおよびPUTリクエストの場合、total_countプロパティは省略できます。

• リストノード (list_nodeエンティティ) エンティティは特別なエンティティであり、リストノードへの参照フィールドは他のエンティティとは異なります。

• 参照フィールドは、複数のエンティティタイプを参照できます。

  list_nodeエンティティを除く、単一のエンティティタイプへの参照を表す

  "field_type": "reference",

  "field_type_data": {

      "targets": [

          {

              "type": "release"

          }

      ],

      "multiple": false

  list_nodeエンティティの参照を表す

  "field_type": "reference",   

  "field_type_data": {

      "targets": [

          {

              "type": "list_node",

              "logical_name": "list_node.severity"

          }

      ],

      "multiple": false

  }

  list_nodeエンティティを除く、複数のエンティティタイプへの参照の表現

  "field_type": "reference",

  "field_type_data": {

      "targets": [

          {

              "type": "defect"

          },

          {

              "type": "story"

          }

      ],

      "multiple": false

  } 

リストノードの参照

"field_type": "reference",   

"field_type_data": {

    "targets": [

        {

            "type": "list_node",

            "logical_name": "list_node.severity"

        }

    ],

    "multiple": false

}

• 文字列値を含むフィールド。

• 値の長さは、max_length入力検証プロパティによって決定されます。

“field_type”: “string”

注: すべてのIDフィールドは文字列であり、整数ではありません。

Final

Maximum Length

必須

Not Null

Read Only

Unique

Sanitization

フィールドの出力にサニタイズを適用し、サニタイズのタイプのオプションを提供します。

参照情報: Sanitization