プロジェクト一覧の取得
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
| HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
|---|---|---|---|
| GET | /api/v26.04/projects | 全時系列のプロジェクト情報を取得 | 〇 |
クエリパラメータ
不要
リクエストヘッダ
「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 | 文字列 | 属性名 |
| setId | 文字列 | マルチプル項目※1のID |
※1：事前に選択肢が決められている属性値の総称です。