クエリ検索 レスポンスボディ
パラメータ一覧
| 項目名 | データ形式 | 説明 |
|---|---|---|
| date | 文字列（「YYYY-MM-DD」形式） | 情報取得日 |
| queryInterval | queryIntervalオブジェクト ※「queryintervalオブジェクト」をご覧ください | クエリ条件の検索期間 |
| queryResult | queryResultオブジェクト ※「queryResultオブジェクト」をご覧ください | 検索結果 |
| timestamp | 文字列（ISO8601形式） | API実行日時 |
サンプル
{
"date": "2024-12-01",
"queryInterval": {
"from": "2024-12-01",
"to": "2024-12-01"
},
"queryResult": [
{
"id": "2Fb9pp1sQhGpRIcz66SPPQ",
"type": "member",
"email": "iij-taro@example.jp",
"attributes": [
{
"attributeId": "4J9wMPgDQJmki9ycfx-Z7g",
"attributeLabel": "会社",
"values": [
{
"reference": "株式会社 ○○○",
"referenceId": "JiKyiXoBSeOV0r_DhlgqAA",
"referenceType": "company",
"validStart": "2024-11-01",
"validEnd": "9999-12-30",
"value": "株式会社 ○○○"
}
]
},
{
"attributeId": "z6JbmwvYQcO5BKnec_FVAA",
"attributeLabel": "姓",
"values": [
{
"validStart": "2024-12-01",
"validEnd": "9999-12-30",
"value": "IIJ"
}
]
},
{
"attributeId": "SLjXIv1nQsi_LQ66l6ffog",
"attributeLabel": "名",
"values": [
{
"validStart": "2024-12-01",
"validEnd": "9999-12-30",
"value": "太郎"
}
]
},
{
"attributeId": "TYJ5hHDZSnugN4Lv6e45kw",
"attributeLabel": "メールアドレス",
"values": [
{
"validStart": "2024-12-01",
"validEnd": "9999-12-30",
"value": "iij-taro@example.jp"
}
]
}
],
"groups": [
{
"groupId": "tMWLbAIASOmrCRHRgBT8GA",
"groupType": "organization",
"groupCode": "",
"name": "××× グループ",
"depth": 1,
"attributes": [],
"parent": null
},
{
"groupId": "JiKyiXoBSeOV0r_DhlgqAA",
"groupType": "company",
"groupCode": "",
"name": "株式会社 ○○○",
"depth": 1,
"attributes": [],
"parent": null
},
{
"groupId": "B9JY2b4KShGNWuNEB8Te9Q",
"groupType": "company",
"groupCode": "",
"name": "△△△ 株式会社",
"depth": 2,
"attributes": [],
"parent": {
"groupId": "JiKyiXoBSeOV0r_DhlgqAA",
"groupType": "company",
"groupCode": "",
"name": "株式会社 ○○○",
"depth": 1,
"attributes": [],
"parent": null
}
},
{
"groupId": "wcZDtU4-RAaGeFz42osJfA",
"groupType": "office",
"groupCode": "",
"name": "東京オフィス",
"depth": 1,
"attributes": [],
"parent": null
}
],
"conditionResults": [
{
"attributeId": "z6JbmwvYQcO5BKnec_FVAA",
"attributeLabel": "姓",
"values": [
{
"validStart": "2024-12-01",
"validEnd": "9999-12-30",
"value": "IIJ"
}
]
}
]
}
],
"timestamp": "2024-12-05T02:00:00.000Z"
}
queryIntervalオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| from | 文字列（「YYYY-MM-DD」形式） | クエリ条件の検索期間開始日 |
| to | 文字列（「YYYY-MM-DD」形式） | クエリ条件の検索期間終了日 |
queryResultオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 実行されたクエリのID |
| type | 以下のいずれかの文字列
| 取得したオブジェクトの種別 |
| 文字列（メール形式） | 取得した従業員のメールアドレス 「type」が「member」の時のみ設定される | |
| attributes | attributeオブジェクトの配列 ※各要素の属性は、「attributeオブジェクト」をご覧ください | 取得したオブジェクトの情報 |
| groups | groupオブジェクトの配列 ※各要素の属性は、「groupオブジェクト」をご覧ください | 取得した従業員が所属している組織・会社・事務所・プロジェクトの情報 「type」が「member」の時のみ設定される |
| conditionResults | conditionResultオブジェクトの配列 | 適合したクエリ条件 |
conditionResultオブジェクト
本パラメータについては実行したクエリによって内容が変わるため、クエリごとに説明します。
AttributeQuery（特定の属性値に対する条件を指定する）利用時の検索結果
| 項目名 | データ形式 | 説明 |
|---|---|---|
| attributeId | 文字列 | 属性のID |
| attributeLabel | 文字列 | 属性の名称 |
| values | valueオブジェクトの配列 ※各要素の属性は、「valueオブジェクト」をご覧ください | 検索時に使われた値 |
DiffQuery (特定の属性値の変化内容を条件として指定する) 利用時の検索結果
| 項目名 | データ形式 | 説明 |
|---|---|---|
| attributeId | 文字列 | 属性のID |
| attributeLabel | 文字列 | 属性の名称 |
| fromvalues | valueオブジェクトの配列 ※各要素の属性は、「valueオブジェクト」をご覧ください | リクエストボディの「fromCondition」に基づいて検索する際に使われた値 |
| tovalues | valueオブジェクトの配列 ※各要素の属性は、「valueオブジェクト」をご覧ください | リクエストボディの「toCondition」に基づいて検索する際に使われた値 |
共通オブジェクト
groupオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| groupId | 文字列 | 取得した組織・会社・事務所・プロジェクトのID |
| groupType | 以下のいずれかの文字列
| 取得した組織・会社・事務所・プロジェクトの種別 |
| groupCode | 文字列 | 取得した組織・会社・事務所・プロジェクトのコード |
| name | 文字列 | 取得した組織・会社・事務所・プロジェクトの名前 |
| depth | 整数値 | 取得した組織・会社・事務所・プロジェクトの階層の深さ |
| attributes | attributeオブジェクトの配列 ※各要素の属性は、「attributeオブジェクト」をご覧ください | 取得した組織・会社・事務所・プロジェクトの属性情報 |
| parent | groupオブジェクト または null ※子となる要素は、この表組み内にある「groupオブジェクト」と同一です | 親組織・親会社・親事務所・親プロジェクトの情報 （存在しない場合はnull） |
attributeオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| attributeId | 文字列 | 属性のID |
| attributeLabel | 文字列 | 属性の名称 |
| values | valueオブジェクトの配列 ※各要素の属性は、「valueオブジェクト」をご覧ください | 該当するオブジェクトの属性値 |
valueオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| reference | 文字列 | 属性が所属しているオブジェクトの名称 所属先がある場合のみ設定される |
| referenceId | 文字列 | 属性が所属しているオブジェクトのID 所属先がある場合のみ設定される |
| referenceType | 文字列 | 属性が所属しているオブジェクトの種類 |
| setId | 文字列 | マルチプル項目※1のID マルチプル項目の場合のみ設定される |
| validStart | 文字列（「YYYY-MM-DD」形式） | 属性値の有効期間開始日 |
| validEnd | 文字列（「YYYY-MM-DD」形式） | 属性値の有効期限終了日 |
| value | 文字列、整数、またはboolean | 属性の値 |
※1：事前に選択肢が決められている属性値の総称です。