公開
マニュアル一覧へ

ご契約者向け
マニュアル一覧へ

IIJ IDガバナンス管理サービス APIリファレンス

クエリ検索 リクエストボディ

クエリ検索APIで利用されるパラメータについて説明します。

パラメータ一覧
項目名 必須 データ形式 デフォルト値 説明
query 〇 queryオブジェクト。項目は、「queryオブジェクト」をご覧ください ー

検索するクエリ条件
attributeSelector ー 文字列の配列

空の配列

取得するメンバー情報の属性を指定する。属性の指定は各属性に割り当てられた「項目ID」を利用すること
groupAttributeSelector ー 文字列の配列 空の配列

取得する会社・事務所・組織・プロジェクト情報の属性を指定する。属性の指定は各属性に割り当てられた「項目ID」を利用すること
例：会社に所属している従業員の所属会社・メールアドレス・姓・名を取得するパラメータ 
{
 
  "query": {
 
    "type": "AttributeQuery",
 
    "condition": {
 
      "attributeId": "4J9wMPgDQJmki9ycfx-Z7g",
 
      "comparisonOperator": "ISNOTNULL",
 
      "referenceIds": []
 
    },
 
    "onlyLatestData": false
 
  },
 
  "attributeSelector": [
 
    "4J9wMPgDQJmki9ycfx-Z7g",
 
    "z6JbmwvYQcO5BKnec_FVAA",
 
    "SLjXIv1nQsi_LQ66l6ffog",
 
    "TYJ5hHDZSnugN4Lv6e45kw"
 
  ],
 
  "groupAttributeSelector": []
 
}
queryオブジェクト

「query」パラメータに必要な項目を利用するクエリごとに説明します。

AttributeQuery（特定の属性値に対する条件を指定する）

項目名 必須 データ形式 デフォルト値 説明
type 〇 文字列「AttributeQuery」 ー

検索で利用するクエリ形式を指定する。特定の属性値を条件に利用する場合は「AttributeQuery」を設定
condition 〇 conditionオブジェクト。項目は、「conditionオブジェクト」をご覧ください ー

値を比較する条件を指定する
onlyLatestData ー boolean（false固定） null

過去のデータも含めて表示させたい場合のみ指定。指定する場合は「false」を設定すること
例：姓が「IIJ」であるメンバーを検索するqueryパラメータ 
{
 
  "type": "AttributeQuery",
 
  "condition": {
 
    "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
 
    "comparisonOperator": "EQ",
 
    "comparisonValue": "IIJ",
 
    "referenceIds": []
 
    },
 
  "onlyLatestData": false
 
}


DiffQuery（特定の属性値の変化内容を条件として指定する）

項目名 必須 データ形式 デフォルト値 説明
type 〇 文字列「DiffQuery」 ー

検索で利用するクエリ形式を指定する。属性値の変化を条件として指定する場合は「DiffQuery」を設定する
fromCondition 〇 conditionオブジェクト。項目は、「conditionオブジェクト」をご覧ください ー

変更前の属性値の状態を指定する
toCondition 〇 conditionオブジェクト。項目は、「conditionオブジェクト」をご覧ください ー

変更後の属性値の状態を指定する
intervalTarget 〇

以下のいずれかの文字列

  • FROM
  • TO
 ー

APIのクエリパラメータで指定した検索期間にもとづいて、「fromCondition」「toCondition」を適用する日時を決定する

  • 「FROM」を指定した場合、「fromCondition」は指定の検索期間を参照し、「toCondition」は指定の検索期間から1日後ろにずらした期間を参照する
  • 「TO」を指定した場合、「fromCondition」は指定の検索期間から1日前にずらした期間を参照し、「toCondition」は指定の検索期間を参照する
diffType 〇

以下のいずれかの文字列

  • IN
  • OUT
 ー

どのような属性値の変化を検索するかを指定する

  • 「IN」を指定した場合、属性値の追加と変更の差分を検索する
  • 「OUT」を指定した場合、属性値の削除と変更の差分を検索する
例：会社に新しく所属したことを検索するqueryパラメータ 
{
 
  "type": "DiffQuery",
 
  "fromCondition": {
 
    "attributeId": "H2jJmfZRR7Ct8k74XqDTjg",
 
    "comparisonOperator": "ISNULL"
 
  },
 
  "toCondition": {
 
    "attributeId": "H2jJmfZRR7Ct8k74XqDTjg",
 
    "comparisonOperator": "ISNOTNULL"
 
  },
 
  "intervalTarget": "TO",
 
  "diffType": "IN"
 
}


LogicalQuery（複数の条件を指定する）

項目名 必須 データ形式 デフォルト値 説明
type 〇 文字列「Logical」 ー

検索で利用するクエリ形式を指定する。複数の条件を指定する場合は「Logical」を設定する
op 〇

以下のいずれかの文字列

  • AND
  • OR
 ー

指定した複数条件の連携方法を指定する

  • 「AND」の場合、指定した条件をAND検索
  • 「OR」の場合、指定した条件をOR条件
conditions 〇 queryオブジェクトの配列。要素ごとの項目は、「queryオブジェクト」をご覧ください ー

配列の要素として指定する条件の詳細を指定する
例：会社に所属しており、かつ組織に所属しているqueryパラメータ 
{
 
  "type": "Logical",
 
  "op": "AND",
 
  "conditions": [
 
    {
 
      "type": "AttributeQuery",
 
      "condition": {
 
        "attributeId": "4J9wMPgDQJmki9ycfx-Z7g",
 
        "comparisonOperator": "ISNOTNULL",
 
        "referenceIds": []
 
      },
 
      "onlyLatestData": false
 
    },
 
    {
 
      "type": "AttributeQuery",
 
      "condition": {
 
        "attributeId": "BjTpbKICS9mSP4C6_XCpgg",
 
        "comparisonOperator": "ISNULL",
 
        "referenceIds": []
 
      },
 
      "onlyLatestData": false
 
    }
 
  ]
 
}
共通オブジェクト
conditionオブジェクト
項目名 必須 データ形式 デフォルト値 説明
attributeId 〇 文字列 ー 参照する属性値の項目IDを指定
comparisonOperator 〇

特定の文字列

 ー 設定できる文字列などについては、「condition - comparison設定」をご覧ください
comparisonValue ー 「comparisonOperator」に応じた形式 ー 設定できる形式については、「condition - comparison設定」をご覧ください
referenceIds 〇 文字列の配列 または null ー 「特定の所属先において、メンバーに付与される属性」を参照する際に、本項目で指定した所属先（会社・事務所・組織・プロジェクト）に関連するもののみを参照するように制限する


condition - comparison設定

「comparisonOperator」設定値

 「comparisonValue」データ形式 設定時の検索条件
EQ

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean
 指定の属性値と「comparisonValue」の値が等しいこと
NE

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean
 指定の属性値と「comparisonValue」の値が等しくないこと
GE

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean

指定の属性値が「comparisonValue」の値より大きい、または等しいこと。データ形式が文字列の場合は、辞書順が後になる方を大きいと判断します
GT

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean

指定の属性値が「comparisonValue」の値より大きいこと。データ形式が文字列の場合は、辞書順が後になる方を大きいと判断します
LE

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean

指定の属性値が「comparisonValue」の値より小さい、または等しいこと。データ形式が文字列の場合は、辞書順が後になる方を大きいと判断します
LT

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean

指定の属性値が「comparisonValue」の値より小さいこと。データ形式が文字列の場合は、辞書順が後になる方を大きいと判断します
FORWARD

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean
 指定の属性値が「comparisonValue」の値と前方一致すること
BACKWARD

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean
 指定の属性値が「comparisonValue」の値と後方一致すること
PATIAL

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean
 指定の属性値が「comparisonValue」の値と部分一致すること
ISNULL 設定不要 指定の属性値が存在しないこと
ISNOTNULL 設定不要 指定の属性値が存在すること
INCLUDE

以下のいずれかの形式

  • 文字列の配列
  • 整数の配列
  • booleanの配列
 指定の属性値が「comparisonValue」の値のいずれかに合致すること
NOTINCLUDE

以下のいずれかの形式

  • 文字列の配列
  • 整数の配列
  • booleanの配列
 指定の属性値が「comparisonValue」の値にいずれも含まれないこと
DESCENDANT_OF_OR_EQ

以下のいずれかの形式

  • 文字列
  • 整数
  • boolean

指定の属性値が「comparisonValue」の値に指定するグループ（会社・事務所・組織・プロジェクト）と一致、またはその配下グループになっていること。「comparisonValue」の指定は、グループIDを利用します