FieldReadConfiguration 構造体 - iOS

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間:3分
  • FieldReadConfiguration 構造を使用すると、ServiceNowインスタンステーブルからフェッチするフィールドと形式を設定できます。

    表 : 1. プロパティ
    名前 タイプ 説明
    includeField アレイ 返される結果で返されるフィールドのリスト。
    オプション アレイ 返されるフィールドのタイプのリスト。
    可能な値:
    • actualValues:参照されるレコードのsys_idsを含む、各フィールドに実際に格納されている値を返します。Dateを使用してCodableモデルで日付をデコードする必要がある場合は、この設定を使用します。
    • description:パラメーターの説明を返します。
    • displayValues:選択したフィールド の表示値 (利用可能な場合) を返します。たとえば、ユーザー名には通常、ユーザーレコードへの参照リンク (sys_id) が含まれています。表示値を要求した場合、関連付けられたフィールドに格納されているsys_idではなく、ユーザーの名前が返されます。
      注:
      ServiceNowインスタンスによって返される表示値は、認証されたユーザーのユーザープロファイル構成に基づいて書式設定され、国際化されます。これは、デバイスの言語やロケールの設定とは異なる場合があります。
    • excludeReferenceLink:テーブル内の参照リンクとして定義されているデータを返しません。
    • rawValue:パラメーターの生の値を返します。

    FieldReadConfiguration init(includeFields: [FieldName] = [], options: Options = [])

    ServiceNowテーブルのレコード内のフィールドを、REST エンドポイント呼び出しの戻り値で返すように構成します。

    表 : 2. パラメーター
    名前 タイプ 説明
    includeField アレイ 返される結果で返されるフィールドのリスト。
    オプション アレイ 返されるフィールドのタイプのリスト。
    可能な値:
    • actualValues:参照されるレコードのsys_idsを含む、各フィールドに実際に格納されている値を返します。Dateを使用してCodableモデルで日付をデコードする必要がある場合は、この設定を使用します。
    • description:パラメーターの説明を返します。
    • displayValues:選択したフィールド の表示値 (利用可能な場合) を返します。たとえば、ユーザー名には通常、ユーザーレコードへの参照リンク (sys_id) が含まれています。表示値を要求した場合、関連付けられたフィールドに格納されているsys_idではなく、ユーザーの名前が返されます。
      注:
      ServiceNowインスタンスによって返される表示値は、認証されたユーザーのユーザープロファイル構成に基づいて書式設定され、国際化されます。これは、デバイスの言語やロケールの設定とは異なる場合があります。
    • excludeReferenceLink:テーブル内の参照リンクとして定義されているデータを返しません。
    • rawValue:パラメーターの生の値を返します。
    表 : 3. 返される内容
    タイプ 説明
    なし

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

    /// The configuration for what to fetch from the Table API.
    lazy var fetchConfiguration: FetchConfiguration = {
      let includeFields = [
        // Case details
        "number",
        "short_description",
        "priority",
        "state",
        "opened_at",
                
        // Account details
        "account.name",
        "account.number",
        "contact.name",
        "contact.email",
        "contact_type",
    
        // Assignment
        "assignment_group.name",
        "assigned_to.name"
      ]
      let readConfiguration = FieldReadConfiguration(includeFields: includeFields, options: .actualValues)
      let filter = Filter(criteria: [], sortBy: [.desc("opened_at")], queryCategory: nil)
      return FetchConfiguration(filter: filter, limit: 10, readConfiguration: readConfiguration)
    }()