クエリ検索
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
---|---|---|---|
POST | /api/v22.10/query | クエリ条件に合致する情報の取得 | ー |
クエリパラメータ
項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
---|---|---|---|---|
baseDate | ー | 下記いずれかの文字列
| 実行日を表す文字列 | 情報取得日 maxLeavingDateを指定した場合、検索期間内で属性が変更(入社・退職・グループへの追加など)された地点での情報を取得する |
from | ー | 文字列(「YYYY-MM-DD」形式) | baseDateと同じ値 | 検索期間の開始日 ※「baseDate」を「maxLeavingDate」にしたときのみ反映されます |
to | ー | 文字列(「YYYY-MM-DD」形式) | baseDateで設定されている日付の翌日を表す文字列 | 検索期間の終了日 ※「baseDate」を「maxLeavingDate」にしたときのみ反映されます |
entityType | ー | 下記いずれかの文字列
| member | 検索する情報の種類
|
リクエストヘッダ
「APIリクエストヘッダ」をご覧ください。
リクエストボディ
検索条件となるクエリを設定します。
詳しくは、「クエリ検索 リクエストボディ」をご覧してください。
レスポンス
レスポンスボディ
「クエリ検索 レスポンスボディ」をご覧ください。