ProductsListByCustomerOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| count | カウント クエリ オプションを使用すると、クライアントは、応答のリソースに含まれる一致するリソースの数を要求できます。 |
| filter | フィルター クエリ オプションを使用すると、クライアントは要求 URL でアドレス指定されたリソースのコレクションをフィルター処理できます。 |
| order |
orderby クエリ オプションを使用すると、クライアントは特定の順序でリソースを要求できます。 |
| search | 検索クエリ オプションを使用すると、クライアントは自由テキスト検索式に一致するコレクション内の項目を要求できます。 検索は、文字列フィールドでのみサポートされています。 |
| skip | skip クエリ オプションは、クエリ対象のコレクション内でスキップされ、結果に含まれない項目の数を要求します。 |
| top | 上位のクエリ オプションは、クエリされたコレクション内のアイテムの数を結果に含めるよう要求します。 top でサポートされる最大値は 50 です。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
count
カウント クエリ オプションを使用すると、クライアントは、応答のリソースに含まれる一致するリソースの数を要求できます。
count?: booleanプロパティ値
boolean
filter
フィルター クエリ オプションを使用すると、クライアントは要求 URL でアドレス指定されたリソースのコレクションをフィルター処理できます。
filter?: stringプロパティ値
string
orderBy
orderby クエリ オプションを使用すると、クライアントは特定の順序でリソースを要求できます。
orderBy?: stringプロパティ値
string
search
検索クエリ オプションを使用すると、クライアントは自由テキスト検索式に一致するコレクション内の項目を要求できます。 検索は、文字列フィールドでのみサポートされています。
search?: stringプロパティ値
string
skip
skip クエリ オプションは、クエリ対象のコレクション内でスキップされ、結果に含まれない項目の数を要求します。
skip?: numberプロパティ値
number
top
上位のクエリ オプションは、クエリされたコレクション内のアイテムの数を結果に含めるよう要求します。 top でサポートされる最大値は 50 です。
top?: numberプロパティ値
number
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
coreClient.OperationOptions.abortSignal から継承
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
coreClient.OperationOptions.onResponse から継承
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
coreClient.OperationOptions.requestOptions から継承
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptionsプロパティ値
coreClient.OperationOptions.serializerOptions から継承
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
coreClient.OperationOptions.tracingOptions から継承