2.2.9 クエリパラメータ
クエリパラメータでは，リクエストに検索条件を付加することで，レスポンスの出力内容をフィルタリングしたり，ソートしたりすることができます。
JP1/AOがサポートするクエリパラメータを示します。
すべてのAPIで指定できるクエリパラメータ
次の表に示すクエリパラメータは，すべてのAPIに指定できます。
パラメータ |
説明 |
指定できる値 |
デフォルト値 |
|---|---|---|---|
alt |
リクエストのContent-TypeヘッダーやAcceptヘッダーと同様に，入出力のデータ形式を指定できます。 |
xmlまたはjson |
－ |
- （凡例）
－：該当しません。
一部のAPIで使用できるクエリパラメータ
次の表に示すクエリパラメータは，一部のAPI※で指定できます。
- 注※
サービステンプレート一覧の取得
サービス一覧の取得
スケジュール一覧の取得
タスク一覧の取得
ステップ一覧の取得
タスクログの取得
履歴一覧の取得
プロパティ定義一覧の取得
プロパティ値一覧の取得
プロパティ定義およびプロパティ値一覧の取得
プロパティグループ一覧の取得
サービスグループ一覧の取得
タググループ一覧の取得
タグ一覧の取得
パラメータ |
説明 |
指定できる値※1 |
デフォルト値 |
|---|---|---|---|
HQL::filter |
指定した条件でフィルタリングします。 |
「2.2.11 HQL規格の使用」を参照してください。 |
－ |
HQL::fields |
レスポンスに含めるメンバーを絞り込むときに指定します。「,」区切りで複数指定できます。 |
メンバー名 |
－ |
HQL::sortBy |
指定されたメンバー名でソートします。 |
メンバー名 [{ASC| DESC}](, メンバー名 [{ASC| DESC}])
|
ASC |
HQL::offset※2 |
情報を取得する先頭オブジェクトの位置を指定します。レスポンスに含めるオブジェクトの最大数はHQL::countで指定します。HQL::offsetよりもpageが優先されます。 |
0～2147483647 |
0 |
HQL::count※2 |
HQL::offsetに指定した先頭オブジェクトの位置を起点に，レスポンスに含めるオブジェクトの最大数を指定します。HQL::countよりもpageSizeが優先されます。なお，HQL::countとHQL::offsetの合計が2,147,483,647を超える場合，HQL::offsetに指定した値から2,147,483,647番目までのオブジェクトを取得します。 |
1～2147483647 |
100 |
page※2 |
リソースを，ページ単位で分割する場合に，指定したページの情報を取得します。pageSizeを同時に指定する必要があります。HQL::offsetよりもpageが優先されます。 |
1～2147483647 |
－ |
pageSize※2 |
1ページに表示するオブジェクトの最大数を指定します。HQL::countよりもpageSizeが優先されます。 |
1～2147483647 |
－ |
- （凡例）
－：該当しません。
- 注※1
URLとして表現できない文字列を値に指定したい場合は，UTF-8形式でURLエンコードしてください。
- 注※2
「タスクログの取得」，「ステップ一覧の取得」および「プロパティグループ一覧の取得」のAPIでは指定できません。
pageSizeには1ページに表示するオブジェクトの最大数を指定し，pageには分割されたページのうちの何ページ目を表示するかを指定します。これは，例えばJP1/AOの画面にある「サービス一覧」の「ページ」や「1ページの行数」と概念は同じです。 pageおよびpageSizeを指定すると，Paginationオブジェクトに全リソース数とページ数が返却されます。この値によって次のページがあるかどうかを判断できます。
なお，pageおよびpageSizeは次の式のとおり，HQL::offsetの値に変換されて利用されます。
HQL::offset=pageSize*(page－1)
そのため，pageおよびpageSizeがHQL::offsetの範囲を超えた場合，ステータスコードは400のBad Requestが返却されます。