🌐
クエリ API
要約リクエストURLHTTPメソッドリクエストパラメータリクエストボディAPIパラメータの仕様Queryオブジェクトその他のオブジェクトレスポンスレスポンスステータスレスポンスボディQueryResultオブジェクトConditionResultオブジェクトその他のオブジェクト
要約
クエリ条件に一致するメンバーやグループの情報を取得します。
リクエスト
リクエストパラメータ
| 名称 | 必須 | 型・形式 | 指定しなかった時の値 | 例 | 説明 |
|---|---|---|---|---|---|
| いいえ | YYYY-MM-DD形式 or | 実行日を表すYYYY-MM-DD形式のstring | 2023-04-01 | クエリ条件の合致した対象の情報取得日 を指定すると各メンバーに対して検索期間内の対象の最新の有効な日付時点の情報を表示する | |
| いいえ | YYYY-MM-DD形式 | と同じ値 | 2022-04-01 | クエリ条件の検索期間開始日 | |
| いいえ | YYYY-MM-DD形式 | の1日語を表すYYYY-MM-DD形式のstring | 2023-10-01 | クエリ条件の検索期間終了日 | |
| いいえ | 次のいずれか - member - company - office - organization - project | member | member | 情報を取得したいエンティティの種類 |
リクエストボディ
APIパラメータをBodyにセットしてリクエストします。
APIパラメータはクイックビューにて条件をを指定して作成します。
APIパラメータの仕様
| 名称 | 必須 | 型・形式 | 説明 |
|---|---|---|---|
| はい | Queryオブジェクト | 検索するクエリ条件 | |
| いいえ | 項目ID（string）の配列 | 取得するメンバー情報の属性 | |
| いいえ | 項目ID（string）の配列 | 取得するグループ情報の属性 |
例：会社がnullでないメンバーの所属会社・メールアドレス・姓・名を取得するリクエストボディ
Queryオブジェクト
クエリ条件を表すオブジェクト
AttributeQueryオブジェクト
ある日付での値をクエリ条件と比較するオブジェクト
| 名称 | 必須 | 型・形式 | 説明 |
|---|---|---|---|
| はい | 「AttributeQuery」 というstring | AttributeQueryであることを表す | |
| はい | ComparisonConditionオブジェクト | 値を比較する条件 | |
| いいえ | false | 指定しないか、falseを指定してください |
例：姓が田中である
LogicalQueryオブジェクト
Queryオブジェクトを連結して条件を構築するオブジェクト
| 名称 | 必須 | 型・形式 | 説明 |
|---|---|---|---|
| はい | 「Logical」 というstring | LogicalQueryオブジェクトであることを表す | |
| はい | 「AND」 か「OR」のstring | ANDの場合は 内の各条件をAND検索。 ORの場合は 内の各条件をOR検索。 | |
| はい | Queryオブジェクトの配列 | 検索するクエリ条件 |
例：会社がnullでない かつ 組織がnullである
DiffQueryオブジェクト
ある項目の値の変化がクエリ条件と比較するオブジェクト
| 名称 | 必須 | 型・形式 | 説明 |
|---|---|---|---|
| はい | 「DiffQuery」 というstring | DiffQueryであることを表す | |
| はい | ComparisonConditionオブジェクト | 変更前の値を比較する条件 | |
| はい | ComparisonConditionオブジェクト | 変更後の値を比較する条件 | |
| はい | 「FROM」 か「TO」のstring | と を適用する検索期間を決定する ”FROM”を指定すると に対して指定した検索期間を適用し、 に対して指定した検索期間を1日後ろにずらした期間を適用する。 ”TO”を指定すると に対して指定した検索期間を適用し、 に対して指定した検索期間を1日前にずらした期間を適用する。 | |
| はい | 「IN」 か「OUT」のstring | どういった項目の変化を検索するか決定する。 ”IN”を指定すると、値の追加と変更の差分を検索する。 ”OUT”を指定すると、値の削除と値変更の差分を検索する。 |
例：会社が未所属からどこかへの追加を検索するDiffQuery
その他のオブジェクト
ComparisonConditionオブジェクト
値を比較する条件を表すオブジェクト
| 名称 | 必須 | 型・形式 | 説明 |
|---|---|---|---|
| はい | 項目IDを表すstring | 値を比較する項目ID | |
| はい | 次のいずれかのstring - EQ - NE - GE - GT - LE - LT - FORWARD - BACKWARD - PATIAL - ISNULL - ISNOTNULL - INCLUDE - NOTINCLUDE - DESCENDANT_OF_OR_EQ | 値の比較演算子 ”EQ”を指定すると値が指定した値と等しいか比較する。 ”NE”を指定すると値が指定した値と等しくないか比較する。 ”GE”を指定すると値が指定した値より大きいか等しいか比較する。 ”GT”を指定すると値が指定した値より大きいか比較する。 ”LE”を指定すると値が指定した値より小さいか等しいか比較する。 ”LT”を指定すると値が指定した値より小さいか比較する。 ”FORWARD”を指定すると値が指定した値と前方一致するか比較する。 ”BACKWARD”を指定すると値が指定した値と後方一致するか比較する。 ”PATIAL”を指定すると値が指定した値と部分一致するか比較する。 ”ISNULL”を指定すると値が存在しないか比較する。 ”ISNOTNULL”を指定すると値が存在するか比較する。 ”INCLUDE”を指定すると値が指定した値に含まれるか比較する。 ”NOTINCLUDE”を指定すると値が指定した値に含まれないか比較する。 ”DESCENDANT_OF_OR_EQ”を指定すると指定した値をIDに持つグループとその下位グループか比較する。 | |
| いいえ | string・number・boolean・stringの配列・numberの配列・booleanの配列・null | 比較に使う値 EQ・NE・GE・GT・LE・LT・FORWARD・BACKWARD・PARTIAL・DESCENDANT_OF_OR_EQの場合はstring・number・booleanの指定が必要。 ISNULL・ISNOTNULLの場合は指定不要。 INCLUDE・NOTINCLUDEの場合はstringの配列・numberの配列・booleanの配列の指定が必要。 | |
| はい | 所属先のIDを表すstringの配列・null | 指定すると、「特定の所属先において、メンバーに付与される属性」については指定された所属先のみを対象とする。 |
例：EQを使ったComparisonConditionオブジェクト
姓が田中と等しい
例：ISNULLを使ったComparisonConditionオブジェクト
姓がnullでない
例：INCLUDEを使ったComparisonConditionオブジェクト
雇用形態が正社員か契約社員に含まれる
レスポンス
レスポンスボディ
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | YYYY-MM-DD形式のstring | 情報取得日 | |
| いいえ | QueryIntervalオブジェクト | クエリ条件の検索期間 | |
| いいえ | QueryResultオブジェクトの配列 | 取得結果 | |
| いいえ | YYYY-MM-DDThh:mm:ss.mmmZ 形式のstring | API実行日時 |
サンプルレスポンス
QueryResultオブジェクト
取得されたメンバーやグループの情報
MemberResultオブジェクト
取得されたメンバー情報
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | string | ID | |
| いいえ | 「member」というstring | メンバーであることを表す | |
| いいえ | string | メールアドレス | |
| いいえ | AttributeValuesオブジェクトの配列 | メンバーの情報 | |
| いいえ | Groupオブジェクトの配列 | 所属先のグループの情報 | |
| いいえ | ConditionResultオブジェクトの配列 | 適合したクエリ条件 |
サンプル
GroupResultオブジェクト
取得されたグループ情報
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | string | ID | |
| いいえ | string | グループの種別を表す | |
| いいえ | AttributeValuesオブジェクトの配列 | グループの情報 | |
| いいえ | ConditionResultオブジェクトの配列 | 適合したクエリ条件 |
サンプル
ConditionResultオブジェクト
クエリ条件と一致した項目を表すオブジェクト
AttributeQueryConditionResultオブジェクト
実行されたAttributeQueryクエリのいずれかと一致した項目を表すオブジェクト
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | string | 属性のID | |
| いいえ | string | 属性の名称 | |
| いいえ | Valueオブジェクトの配列 | 検索時に使われた値 |
サンプル
DiffQueryConditionResultオブジェクト
実行されたDiffQueryクエリのいずれかと一致した項目を表すオブジェクト
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | string | 属性のID | |
| いいえ | string | 属性の名称 | |
| いいえ | Valueオブジェクトの配列 | の検索時に使われた値 | |
| いいえ | Valueオブジェクトの配列 | の検索時に使われた値 |
サンプル
その他のオブジェクト
QueryIntervalオブジェクト
クエリ条件の検索期間を表すオブジェクト
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | YYYY-MM-DD形式のstring | クエリ条件の検索期間開始日 | |
| いいえ | YYYY-MM-DD形式のstring | クエリ条件の検索期間終了日 |
サンプル
AttributeValuesオブジェクト
メンバーやグループの各項目とその値を表すオブジェクト
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | string | 属性のID | |
| いいえ | string | 属性の名称 | |
| いいえ | Valueオブジェクトの配列 | 取得したメンバーやグループの属性の値 |
サンプル
Valueオブジェクト
メンバーやグループの各項目の値を表すオブジェクト
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | string | 所属先の名称 所属先がない場合は返らない | |
| いいえ | string | 所属先のID 所属先がない場合は返らない | |
| いいえ | string | 所属先の種類 所属先がない場合は返らない | |
| いいえ | string | マルチプル項目のID マルチプル項目でない場合は返らない | |
| いいえ | YYYY-MM-DD形式のstring | 値の有効期間開始日 | |
| いいえ | YYYY-MM-DD形式のstring | 値の有効期間終了日 | |
| いいえ | string・number・boolean | 属性の値 |
サンプル
Groupオブジェクト
メンバーの所属グループを表すオブジェクト
| 名称 | Nullable | 型・形式 | 説明 |
|---|---|---|---|
| いいえ | string | グループのID | |
| いいえ | string | グループの種類 | |
| いいえ | string | グループコード | |
| いいえ | string | グループの名称 | |
| いいえ | number | 階層における深さ | |
| いいえ | AttributeValuesオブジェクトの配列 | グループの項目情報 | |
| はい | Groupオブジェクト | 親グループのオブジェクト 存在しない場合はnull |