FieldReadConfiguration クラス: Android

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:2分
  • FieldReadConfiguration クラスには、応答レコードで返すフィールドと返さないフィールドを定義する機能があります。

    表 : 1. プロパティ
    名前 タイプ Description (説明)
    includeField collection<string> 応答で返すフィールド。
    クエリアイテム マップ<文字列、文字列> 読み取り専用です。読み取り構成を表すクエリーアイテムのコレクション。
    queryParams クエリパラメーター 要求クエリパラメーターの名前と値のペアを含む反復可能な構造。これらのパラメーターを使用して要求を作成します。

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

    関連付けられた ServiceNow テーブルからの応答を返すために含めるフィールドを定義します。

    表 : 2. パラメーター
    名前 タイプ Description (説明)
    includeField 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)