OCAPI プロパティ選択 23.1

プロパティセレクターを使用すると、API によって取得されるリソースプロパティの数を減らすことができます。このため、必要なプロパティのみを取得すると同時に、ネットワーク帯域幅を削減できます。

リクエストで select パラメーターを設定することで、すべてのリソースタイプに対してプロパティセレクターを指定できます。実際のセレクター値は、かっこで囲む必要があります。次の表に、プロパティセレクターの機能と、対応する select パラメーター値をリストします:

機能	select パラメーターの値
複合プロパティを含む、すべてのレベルのプロパティを含めます。	(**)
複合プロパティを除く、トップレベルのプロパティを含めます。	(*)
1 つのプロパティを含めます。	(price) (+price)
1 つのプロパティを除外します。	(-price)
下位ドキュメントプロパティを含めます。	(variation_attributes.(**))
配列内の最初のドキュメントのみを返します。インデックスは 0 から始まります。	(variation_attributes[0].(**))
配列内の最初の 5 つのドキュメントのみを返します。インデックスは 0 から始まります。	(variation_attributes[0:4].(**))
配列内の 2 番目、4 番目、および 6 番目のドキュメントのみを返します。インデックスは 0 から始まります。	(variation_attributes[1,3,5].(**))
フィルターに一致する配列内のドキュメントのみを返します。フィルター式の構文は ?(_boolean_expression_) です。サポートされる演算子: ==, !=, <=, >=, <, >	(variation_attributes[?(@.name=='color')].(**))
フィルターで OR (||) および AND (&&) を組み合わせます。	(variation_attributes[?(@.name=='color' && @.id=='size')].(**))

1 つのプロパティ名、あるいはかっこで囲ったプロパティ名のコンマ区切りリストを指定できます。次の例で、商品リソースインスタンスの name、id、および variation_attributes プロパティの選択方法を示します:

下位のプロパティを選択するには、結果のすべてのレベルを正確に指定する必要があります。次の例では、取得される注文レコードのフィールドを選択してそのフィールドで並べ替えを行うために 3 レベルの深さまで検索を行う、フィルタリング注文検索を示しています。