問合せパラメータの操作

RESTエンドポイントでは、エンドポイントURLに追加できる静的問合せパラメータおよび動的問合せパラメータがサポートされており、エンドポイント・レスポンスで返されるデータを制御できます。たとえば、qパラメータを使用して、指定した基準に基づいて結果を制限するフィルタ式を作成したり、limitを使用して返されるレコードの数を制限できます。

GETメソッドで使用できる一般的な問合せパラメータのリストを次に示します:

問合せのパラメータ	タイプ	説明
`expand`	文字列	ネストされたオブジェクトから、`?expand=Employee.JobHistory`などの拡張形式で追加情報を返します。
`fields`	文字列	指定された属性に基づいて返されるデータをフィルタします(例:`?fields=Name,Location;Employee:FirstName,LastName`)。
`onlyData`	ブール	`onlyData=true`の場合、フィールド値のみを返し、リンクを除外するようにデータをフィルタします。
`links`	文字列	指定されたオブジェクトのリンクを返します(たとえば、`?links=linkType1,linkType2`)。
`limit`	integer	返されるレコード数を制限します(たとえば、`?limit=200`)。レスポンスが大きくなりすぎないようにするには、フェッチするレコードの数を適切に設定してください。数値が大きすぎると、タイムアウトが発生し、ファクタの組合せによって発生する内部サーバー・エラーも発生する可能性があります。
`offset`	integer	レコードを取得する必要がある開始位置(`?offset=4`など)を指定することで、結果をページングできます。
`totalResults`	ブール	`totalResults=true`の場合に使用可能なレコードの合計数を返します。
`q`	文字列	数値の比較や、アイテムのプロパティの値と一致する文字列などの基準に基づいて返されるアイテムを制限するフィルタ式を指定します(たとえば、`?q=(Deptno>=10 and <= 30) and (Loc!=NY)`)。
`orderBy`	文字列	フィールドのデータを昇順または降順でソートします(たとえば、`orderBy=salary`または`?orderBy=salary:asc,DepartmentName:desc`)。

問合せパラメータとユースケースの詳細は、「REST APIを使用したビジネス・オブジェクトへのアクセス」の「ビジネス・オブジェクトの取得」を参照してください。「エンドポイント」リファレンスも参照してください。