メインコンテンツへ

プロジェクトの取得

ベースURL: https://api.tensorenergy.jp/v1

パス: /assets

メソッド: GET

クエリパラメータ​

このAPIはクエリパラメータを必要としません。

レスポンス​

レスポンスは次のフィールドを持つnull不可のJSONオブジェクトです。

フィールドタイプ説明
data[Asset] | nullクエリから返されたデータ。errorがnullでない場合、この値はnullになります。
errorError | nullクエリから返されたエラー。dataがnullでない場合、この値はnullになります。

Assetオブジェクト​

フィールドタイプ説明
idstringプロジェクトのID。
namestringプロジェクトの名前。
statusoperation | planning | maintenanceプロジェクトのステータス。
grid_zonechugoku | chubu | kyushu | hokkaido | hokuriku | tokyo | kansai | tohoku | shikoku | okinawaプロジェクトが所在する送配電エリア。
latitudefloatプロジェクトの緯度。地球の赤道から北または南への距離を度で表現。
longitudefloatプロジェクトの経度。地球の赤道から東または西への距離を度で表現。
altitudefloatプロジェクトサイトの高度。メートルで表現。
location_namestringプロジェクトの所在地の名前。
subsidy_schemefit | fip | noneプロジェクトが現在受けている補助金制度。
subsidy_ratenumber | nullプロジェクトのために承認されたFITまたはFIPの日本円での金額。プロジェクトの補助金制度がnoneでない場合のみnullでないことが保証されます。
subsidy_start_datestring | nullプロジェクトの補助金開始日時。ISO 8601準拠のUTCタイムスタンプで表現。プロジェクトの補助金制度がnoneでない場合のみnullでないことが保証されます。
cod_datestringグリッド接続の予定日。ISO 8601準拠のUTCタイムスタンプで表現。
metering_dayintegerプロジェクトの検針日。
meti_permit_numberstring | nullプロジェクトの設備認定番号。
meti_application_idstring | nullプロジェクトの電子申請ID。
location_idstring | nullプロジェクトの受電地点特定番号。
developer_idstring | nullデベロッパーのID。
om_provider_idstring | nullOMプロバイダーのID。
epc_company_idstring | nullEPC会社のID。
balancing_group_idstringプロジェクトが関連付けられているバランシンググループのID。
spv_idstring | nullプロジェクトが関連付けられているSPVのID。
readable_idstringプロジェクトの読み取り可能なID。形式はXXX-A-{INTEGER}。例: XXX-A-1またはXXX-A-10。
is_using_advanced_lossesbooleanプロジェクトが高度な損失フラグを使用しているかどうかを示します。
simulation_statussucceeded | failed | pending | runningプロジェクトのシミュレーションのステータス。
created_atstringプロジェクトが作成された日時。ISO 8601準拠のUTCタイムスタンプで表現。
updated_atstringプロジェクトが更新された日時。ISO 8601準拠のUTCタイムスタンプで表現。
creator_user_idstringプロジェクトを作成したユーザーのID。
grid_codestring | nullOCCTO提出ファイルの系統コード。
contract_classification_number_2string | nullOCCTO提出ファイルの契約識別番号2。
scenario_idstringプロジェクトに関連付けられているシナリオのID。

エラーオブジェクト​

フィールドタイプ説明
messagestring問題が発生したことを説明するメッセージ。
codeinternal_server_error | not_authorized発生したエラーコード。

リクエスト例​

curl --request GET \
     --url https://api.tensorenergy.jp/v1/assets \
     --header "authorization: Bearer ${API_TOKEN}"

レスポンス例​

操作中にエラーが発生しない場合​

{
  "data": [
    {
        "id": "51d5ffcf-1347-4277-93e8-dfca140fe8b3",
        "name": "Demo asset",
        "status": "planning",
        "grid_zone": "tokyo",
        "latitude": 38.543,
        "longitude": 138.564,
        "altitude": 0,
        "location_name": "Greenfield",
        "subsidy_scheme": "none",
        "subsidy_rate": null,
        "subsidy_start_date": null,
        "cod_date": "2022-01-01T15:00:00Z",
        "metering_day": 1,
        "meti_permit_number": null,
        "meti_application_id": null,
        "location_id": null,
        "developer_id": null,
        "om_provider_id": null,
        "epc_company_id": null,
        "balancing_group_id": "5ca33061-3ad3-4051-9518-0af37f68f861",
        "spv_id": null,
        "readable_id": "XXX-A-1",
        "is_using_advanced_losses": true,
        "simulation_status": "succeeded",
        "created_at": "2021-12-29T15:21:11Z",
        "updated_at": "2022-01-01T12:11:00Z",
        "creator_user_id": "9696f450-569d-4c79-995b-36d959eb3182",
        "grid_code": null,
        "contract_classification_number_2": null,
        "scenario_id": "c387383d-bf50-4c90-8a82-f72ad6383ba4"
    }
  ],
  "error": null
}

操作中にエラーが発生する場合​

{
  "data": null,
  "error": {
    "message": "something went wrong during the process",
    "code": "internal_server_error"
  }
}

ワークスペース内にプロジェクトが存在せず、操作中にエラーは発生しません。​

{
  "data": [],
  "error": null
}