組織一覧の取得
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
| HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
|---|---|---|---|
| GET | /api/v22.10/organizations | 全時系列の組織情報を取得 | 〇 |
クエリパラメータ
不要
リクエストヘッダ
「APIリクエストヘッダ」をご覧ください。
リクエストボディ
不要
レスポンス
レスポンスボディ
| 項目名 | データ形式 | 説明 |
|---|---|---|
| data | 組織を表すオブジェクトの配列。各要素の属性は、「dataオブジェクト」をご覧ください | 本サービス上で登録されている組織情報 |
dataオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 組織ID（システムで設定） |
| name | 文字列 | 組織名 |
| code | 文字列 | 組織コード |
| depth | 整数値 | 組織が作成されている深さ |
| parent | 親組織を表すオブジェクトの配列。各要素の属性は、「parentオブジェクト」をご覧ください | 親組織が存在しない場合はnullを返す |
| validStartDate | 文字列（「YYYY-MM-DD」形式） | 組織の有効期間開始日 |
| validEndDate | 文字列（「YYYY-MM-DD」形式） | 組織の有効期間終了日 |
| attributes | attributeオブジェクトの配列。各要素の属性は、「attributeオブジェクト」をご覧ください | 取得した組織の属性情報 |
parentオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 親組織のID（システムで設定） |
| name | 文字列 | 親組織の名称 |
| code | 文字列 | 親組織コード |
attributesオブジェクト
| 項目名 | データ形式 | 説明 |
|---|---|---|
| value | 「dataType」に規定の形式 | 属性値の内容 |
| dataType | 文字列 | 属性値の形式を規定 |
| entityId | 文字列 | 「data」パラメータの「id」と同じ値。組織のIDと同じ値 |
| attributeId | 文字列 | 属性のID |
| attributeLabel | 文字列 | 属性名 |
| referenceId | 文字列 | 所属先のID。会社・組織・事務所・プロジェクトに所属している従業員に付与される属性の場合に利用。所属先に関連しない項目の場合は「AAAAAAAAAAAAAAAAAAAAAA」が設定される |
| referenceName | 文字列またはnull | 所属先の名称。会社・組織・事務所・プロジェクトに所属している従業員に付与される属性の場合に利用。所属先に関連しない項目の場合は「null」 |
| referenceType | 文字列またはnull | 所属先グループの種別。会社・組織・事務所・プロジェクトに所属している従業員に付与される属性の場合に利用。所属先に関連しない項目の場合は「null」 |
| setId | 文字列 | マルチプル項目※1のID マルチプル項目ではない場合は「AAAAAAAAAAAAAAAAAAAAAA」 |
※1：事前に選択肢が決められている属性値の総称です。