パラメータの問合せ

一部のリクエストでは、返されるデータを変更または拡張するオプションの問合せパラメータを取ります。詳細については、各リソースのドキュメントを参照してください。すべてのリソースがすべての問合せパラメータをサポートしているわけではありません。このセクションでは、リソースが指定された問合せパラメータを実装する場合に使用される一般的な問合せパラメータについてのみ説明します。

表 1-2  一般的な問合せパラメータ

パラメータ 説明 props=true リソースのプロパティーメタデータを一覧表示します (デフォルトは false) limit=n 返されるリスト要素の数を制限します start=n 返される要素データの開始に使われるインデックス番号 (または時間)

問合せパラメータ: props

props 問合せパラメータは、単一のリソースインスタンスを返す多くの GET コマンドで使用できます。これは、プロパティーメタデータのリストを含む「props」データ要素を返します。

表 1-3  プロパティーメタデータ値

プロパティー 説明 name プロパティー名 label プロパティーの説明 immutable プロパティーを変更できないことを示すフラグ type プロパティーの型: String、Integer、Boolean... choices 列挙されたプロパティーの場合、使用可能な値の配列

問合せパラメータ: limit

limit 問合せは、返される要素の最大数を制限するために、多数の要素を返す可能性のある多くの GET コマンドで使用できます。

問合せパラメータ: start

start 問合せパラメータは、limit パラメータをサポートする同じコマンドでサポートされています。返されるデータの開始に使用される開始インデックスを指定します。時間値をサポートするリソースの場合、インデックスは「20130531T01:13:58」などの時間値になることがあります。