🌐

クエリ API

URL

HTTPメソッド

リクエストパラメータ

名称必須型・形式指定しなかった時の値説明
いいえ次のいずれか - YYYY-MM-DD形式 - maxLeavingDate実行日を表すYYYY-MM-DD形式のstring2023-04-01情報取得日 maxLeavingDateを指定した場合、退職日時点や抽出日時点の値を取得※
いいえYYYY-MM-DD形式 と同じ値2022-04-01クエリ条件の検索期間開始日
いいえYYYY-MM-DD形式 の1日語を表すYYYY-MM-DD形式のstring2023-10-01クエリ条件の検索期間終了日
いいえ次のいずれか - member - company - office - organization - projectmembermember情報を取得したいエンティティの種類
※ maxLeavingDateについて詳しくはこちらをご覧ください。

リクエストボディ

APIパラメータをBodyにセットしてリクエストします。
APIパラメータはクイックビューにて条件をを指定して作成します。
 

APIパラメータの仕様

 
名称必須型・形式説明
はいQueryオブジェクト検索するクエリ条件
いいえ項目ID(string)の配列取得するメンバー情報の属性
いいえ項目ID(string)の配列取得するグループ情報の属性
例:会社がnullでないメンバーの所属会社・メールアドレス・姓・名を取得するリクエストボディ

Queryオブジェクト

クエリ条件を表すオブジェクト
AttributeQueryオブジェクト
ある日付での値をクエリ条件と比較するオブジェクト
名称必須型・形式説明
はい「AttributeQuery」 というstringAttributeQueryであることを表す
はいComparisonConditionオブジェクト値を比較する条件
いいえfalse指定しないか、falseを指定してください
例:姓が田中である
LogicalQueryオブジェクト
Queryオブジェクトを連結して条件を構築するオブジェクト
名称必須型・形式説明
はい「Logical」 というstringLogicalQueryオブジェクトであることを表す
はい「AND」 か「OR」のstringANDの場合は 内の各条件をAND検索。 ORの場合は 内の各条件をOR検索。
はいQueryオブジェクトの配列検索するクエリ条件
例:会社がnullでない かつ 組織がnullである
 
DiffQueryオブジェクト
ある項目の値の変化がクエリ条件と比較するオブジェクト
名称必須型・形式説明
はい「DiffQuery」 というstringDiffQueryであることを表す
はい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オブジェクト
雇用形態が正社員か契約社員に含まれる
 

レスポンス


レスポンスステータス

200 OK

レスポンスボディ

名称Nullable型・形式説明
いいえYYYY-MM-DD形式のstring情報取得日
いいえQueryIntervalオブジェクトクエリ条件の検索期間
いいえQueryResultオブジェクトの配列取得結果
いいえYYYY-MM-DDThh:mm:ss.mmmZ 形式のstringAPI実行日時
サンプルレスポンス

QueryResultオブジェクト

取得されたメンバーやグループの情報
MemberResultオブジェクト
取得されたメンバー情報
名称Nullable型・形式説明
いいえstringID
いいえ「member」というstringメンバーであることを表す
いいえstringメールアドレス
いいえAttributeValuesオブジェクトの配列メンバーの情報
いいえGroupオブジェクトの配列所属先のグループの情報
いいえConditionResultオブジェクトの配列適合したクエリ条件
サンプル
GroupResultオブジェクト
取得されたグループ情報
名称Nullable型・形式説明
いいえstringID
いいえ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
サンプル