FieldReadConfiguration クラス: Android

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：2分

    • FieldReadConfiguration クラスは、応答レコードで返すフィールドと返さないフィールドを定義する機能を提供します。

    表 : 1. プロパティ
    名前 タイプ 説明
    includeFields Collection<String> 応答で返すフィールド。
    queryItem Map<String, String> 読み取り専用です。読み取り構成を表すクエリアイテムのコレクション。
    queryParams QueryParams 要求クエリパラメーターの名前と値のペアを含む反復可能な構造。これらのパラメーターを使用して要求をビルドします。

    FieldReadConfiguration - FieldReadConfiguration(includeFields: Collection<String> = listOf(), vararg options: FieldReadConfiguration.Options)

    関連する ServiceNow テーブルからの応答を返すフィールドを定義します。

    表 : 2. パラメーター
    名前 タイプ 説明
    includeFields Collection<String> 応答で返すカンマ区切りフィールドのリスト。リストが空の場合、すべてのフィールドが返されます。
    vararg オプション FieldReadConfiguration.Options オプション。返されるフィールド情報のタイプを定義する 0 個以上のオプションのアレイ。
    可能な値：
    • ACTUAL_VALUES:フィールドの実際の値を応答に含めます。
    • DISPLAY_VALUES:フィールドの表示値を応答に含めます。
    • EXCLUDE_REFERENCE_LINK:参照フィールドの テーブル API リンクを除外します。

    次のコード例は、この関数を呼び出す方法を示しています。

    val readConfiguration = FieldReadConfiguration(
  includeFields = listOf("sys_id", "sys_created_on", "short_description"),
  options = arrayOf(FieldReadConfiguration.Options.DISPLAY_VALUES)
)
val fetchConfiguration = FetchConfiguration(
  filter = Filter("active=true"),
  readConfiguration = readConfiguration
)
val response = nowTableService.records("incident", fetchConfiguration).execute()
handleResponse(response)