Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleAPI result
Code Block
{
    "plantId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "epochId": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
    "epochStart": "2023-05-03",
    "epochEnd": "2024-05-29"
}

...

GET /visualization/plant/{plantId}

...

Call

{{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plant}}/year/{{year}}/month/{{month}}

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/visualization/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/year/2024/month/05

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    year = i.e. 2024
    • Add the year you want to request the months data for

  • month = i.e. 05

    • Add the moth you want to request the data from

Result

Expand
titleAPI result

GET /visualization/plant/{plantId}/year/{year}

Call

{{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plant}}/year/{{year}}

Parameter

...

Code Block
{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

...

baseURL = https://api.enerest.world

  • Do NOT change that! It is always the same for every user

...

portal = solarCompanyXYZ

  • Here you should add the first part of the portal domain

  • Without .enerest.world

plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

...

Add your plants ID here

This ID can be found in

...

the administration/plants call or

in the last part of the URL when you select the plant in the portal

...

",
    "label": "1x EV Charger, 1x Battery, 4x Meter, 1x Inverter",
    "vendor": "SDS",
    "fleets": [
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

...

year = i.e. 2024

  • Add the year you want to request the data from

Result

...

titleAPI result

GET /visualization/plant/{plantId}/lifetime

Call

{{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plant}}/lifetime

Parameter

...

"
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

...

baseURL = https://api.enerest.world

  • Do NOT change that! It is always the same for every user

...

portal = solarCompanyXYZ

  • Here you should add the first part of the portal domain

  • Without .enerest.world

...

"
        }
    ],
    "healthStatus": "OK",
    "deviceFullName": "Solar-Log Base 15",
    "targetPercentage": 95,
    "migrationInProgress": false,
    "size": 15000,
    "componentsClasses": [
        "production",
        "battery",
        "hidden",
        "subconsumption",
        "meter",
        "consumption",
        "intern"
    ]
}

...

GET /visualization/plant/{plantId}/year/{year}/month/{month}

Call

{{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plant}}/year/{{year}}/month/{{month}}

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/visualization/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

...

Add your plants ID here

/year/2024/month/05?channelNames[]=ProdEtotal

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Result

...

titleAPI result
        • -XXXXXXXXXXXX

  • year = i.e. 2024

    • Add the year you want to request the months data for

  • month = i.e. 05

    • Add the moth you want to request the data from

  • channelNames = ProdEtotal

Result

Expand
titleAPI result
Code Block
[
    {
        "month": "05",
        "year": "2024",
        "dataPoints": {
            "2024-05-01": 34597,
            "2024-05-02": 17151,
            "2024-05-03": 14121,
            "2024-05-04": 31210,
            "2024-05-05": 27454,
            "2024-05-06": 9932,
            "2024-05-07": 9617,
            "2024-05-08": 18344,
            "2024-05-09": 21416,
            "2024-05-10": 42849,
            "2024-05-11": 43770,
            "2024-05-12": 39372,
            "2024-05-13": 31881,
            "2024-05-14": 41303,
            "2024-05-15": 19168,
            "2024-05-16": 21226,
            "2024-05-17": 20751,
            "2024-05-18": 35352,
            "2024-05-19": 42451,
            "2024-05-20": 39121,
            "2024-05-21": 13186,
            "2024-05-22": 20978,
            "2024-05-23": 12642,
            "2024-05-24": 27201,
            "2024-05-25": 34543,
            "2024-05-26": 35689,
            "2024-05-27": 16187,
            "2024-05-28": 38914,
            "2024-05-29": 19377,
            "2024-05-30": 21581,
            "2024-05-31": 7203
        },
        "id": "XXXXXXXXXXXX",
        "deviceId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "deviceType": "Datasource",
        "name": "ProdEtotal",
        "unit": "Wh"
    }
]

...

GET /visualization/plant/{plantId}/year/{year}

Call

{{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plant}}/year/{{year}}

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/visualization/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/year/2024?channelNames[]=ProdEtotal

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

  • year = i.e. 2024

    • Add the year you want to request the data from

  • channelNames = ProdEtotal

Result

Expand
titleAPI result
Code Block
[
    {
        "year": "2024",
        "dataPoints": {
            "01": 113825,
            "02": 298057,
            "03": 501545,
            "04": 664448,
            "05": 808587,
            "06": 772720,
            "07": 983287,
            "08": 942899,
            "09": 217760,
            "10": null,
            "11": null,
            "12": null
        },
        "id": "XXXXXXXXXXXX",
        "deviceId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "deviceType": "Datasource",
        "name": "ProdEtotal",
        "unit": "Wh"
    }
]

...

GET /visualization/plant/{plantId}/lifetime

Call

{{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plant}}/lifetime

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/visualization/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/lifetime

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

...

Expand
titleAPI result
Code Block
{[
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",{
    "label": "1x EV Charger, 1x Battery, 4x Meter, 1x Inverter",
    "vendordataPoints": "SDS",
    "fleets": [
        {
            "id2023": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        }6570789,
        {             "id"2024": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"5303128
        },
    ],
    "healthStatusid": "OKXXXXXXXXXXXX",
    "deviceFullName": "Solar-Log Base 15",     "targetPercentagedeviceId": 95,
    "migrationInProgress": falseXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "size": 15000,
    "componentsClassesdeviceType": [
        "production"Datasource",
        "batteryname",
        "hidden: "ProdEtotal",
        "subconsumption",
        "meter",unit": "Wh"
        "consumption",
        "intern"
    ]
}}
]

...

GET /visualization/plant/{plantId}/channels...

...

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

  • dateFrom = 2024-01-24

    • The date can be either

      • today or

      • any Date YYYY-MM-DD

  • dateTo = 2024-01-25

    • The date can be either

      • today or

      • any Date YYYY-MM-DD

  • channelName channelNames = ProdPac & ProdEtotal

    • The Channels can be combined in one request

    • See channel list for more channels

...