組織・会社・事業所・プロジェクト情報の取得
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
| HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
|---|---|---|---|
| GET | /api/v20.06/groupTree | 組織・会社・事業所・プロジェクトの構成情報の取得 | ー |
クエリパラメータ
| 項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
|---|---|---|---|---|
| groupType | 〇 | 以下のいずれかの文字列
| organization | 検索するオブジェクトの種類を指定
|
| baseDate | ー | 文字列（「YYYY-MM-DD」形式） | 実行日を表す文字列 | 情報取得日 |
リクエストヘッダ
「APIリクエストヘッダ」をご覧ください。
リクエストボディ
不要
レスポンス
レスポンスボディ
| 項目名 | データ形式 | 説明 |
|---|---|---|
| date | 文字列（「YYYY-MM-DD」形式） | 情報取得日 |
| groups | groupオブジェクトの配列 ※各要素の属性は、「groupオブジェクト」をご覧ください | 取得された組織・会社・事業所・プロジェクトの情報 |
| timestamp | 文字列（ISO8601形式） | API実行日時 |
groupオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| entityId | 文字列 | 取得した組織・会社・事務所・プロジェクトのID |
| name | 文字列 | 取得した組織・会社・事務所・プロジェクトの名称 |
| attributes | attributeオブジェクトの配列 ※各要素の属性は、「attributeオブジェクト」をご覧ください | 取得した組織・会社・事務所・プロジェクトの属性情報 |
attributeオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| attributeId | 文字列 | 属性のID |
| attributeLabel | 文字列 | 属性の名称 |
| values | valueオブジェクトの配列 ※各要素の属性は、「valueオブジェクト」をご覧ください | 該当するオブジェクトの属性値 |
valueオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| setId | 文字列 | マルチプル項目※1のID マルチプル項目ではない場合は「AAAAAAAAAAAAAAAAAAAAAA」 |
| validStart | 文字列（「YYYY-MM-DD」形式） | 属性値の有効期間開始日 |
| validEnd | 文字列（「YYYY-MM-DD」形式） | 属性値の有効期限終了日 |
| value | 文字列、整数、またはboolean | 属性の値 |
※1：事前に選択肢が決められている属性値の総称です。