Fields フィルタ

fields フィルタは、結果に含める、または結果から除外するプロパティ（フィールド）を指定します。

REST API

filter[fields][propertyName]=<true|false>&filter[fields][propertyName]=<true|false>...

RESTに複数のフィールドを含めるには、複数のフィルタを使用することに注意してください。

また、REST検索で文字列化したJSON形式を使用することもできます。

Node API

{ fields: {propertyName: <true|false>, propertyName: <true|false>, ... } }

ここで、

• propertyName は含める、または除外するプロパティ（フィールド）の名前と同じです。
• <true|false> は、true または false の真偽値リテラルを表します。プロパティを結果に含めるには true を、結果から除外するには false を使います。

既定では、検索は結果内のすべてのモデルプロパティを返します。ただし、値が trueのfieldsフィルタを１つでも指定すると、既定では、特にフィルタに含まれているフィールド のみ が検索されます。

例

id・make・modelプロパティのみを返します。

REST

?filter[fields][id]=true&filter[fields][make]=true&filter[fields][model]=true

{ fields: {id: true, make: true, model: true} }

戻り値：

[{
    "id": "1",
    "make": "Nissan",
    "model": "Titan"
  }, {
    "id": "2",
    "make": "Nissan",
    "model": "Avalon"
  },
  ...
]

vin プロパティを除外します。

REST

?filter[fields][vin]=false

{ fields: {vin: false} }