Documentation Powered by Redocly

SunPeek API (0.4.15)

Download OpenAPI specification:Download

data

Zero Div

This is a usage example only for the log class and the HTTP exception raising. It must be deleted for release.

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get timestamps when data associated with the plant start and end.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z"
}

Triggers calculation of the daily-summarized NaN report for all sensors.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "nan_report": {
    }
}

Get measurement data of a single sensor by id

path Parameters
id
required
integer (Id)
required
integer or string (Plant Id)
query Parameters
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Upload measurement data to plant

Ingests csv files to database. For details, see docstring of the data_uploader module.

Parameters

plant_id : A pre-configured plant with this name must exist in the database. files : list List of csv files that are batch ingested. datetime_template : DatetimeTemplates Templates to simplify the definition of a datetime format. Overridden by datetime_format (if not None). datetime_format : str Used to parse datetimes from csv file. Leave to None infers the format. timezone : str or pytz.timezone. Optional. To be provided if timestamps in the data have no time zone information. csv_separator : str Used in pd.read_csv as 'sep' kwarg csv_decimal : str Used in pd.read_csv as 'decimal' kwarg csv_encoding : str Used in pd.read_csv as 'encoding' kwarg index_col : int DataUploader will try to parse timestamps from this column. response : fastapi.Response sess : sqlalchemy.orm.Session crd : api.dependencies.crud

Returns

upload_response : DataUploadResponse

Raises

ConnectionError HTTPException

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
datetime_template
any (DatetimeTemplates)
Enum: "year_month_day" "day_month_year" "month_day_year"

An enumeration.

datetime_format
string (Datetime Format)
timezone
string (Timezone)
csv_separator
string (Csv Separator)
Default: ";"
csv_decimal
string (Csv Decimal)
Default: "."
csv_encoding
string (Csv Encoding)
Default: "utf-8"
index_col
integer (Index Col)
Default: 0
token
required
string (Token)
Request Body schema: multipart/form-data
files
required
Array of strings <binary> (Files)

Responses

Response samples

Content type
application/json
{
  • "n_uploaded_data_rows": 0,
  • "n_duplicates_index": 0,
  • "response_per_file": [
    ],
  • "db_response": { }
}

Delete measurement data from plant in given interval

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
start
required
string <date-time> (Start)
end
required
string <date-time> (End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Delete all data from plant

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get Data Inspection

Ingests csv files to database. For details, see docstring of the data_uploader module.

Parameters

plant_id : A pre-configured plant with this name must exist in the database. files : list List of csv files that are batch ingested. csv_separator : str Used in pd.read_csv as 'sep' kwarg csv_decimal : str Used in pd.read_csv as 'decimal' kwarg csv_encoding : str Used in pd.read_csv as 'encoding' kwarg index_col : int DataUploader will try to parse timestamps from this column. datetime_template : DatetimeTemplates Templates to simplify the definition of a datetime format. Overridden by datetime_format (if not None). datetime_format : str Used to parse timestamps from csv file. Leave to None infers the format. timezone : str or pytz.timezone. Optional. To be provided if timestamps in the data have no time zone information. response : fastapi.Response sess : sqlalchemy.orm.Session crd : api.dependencies.crud

Returns

upload_response : DataColumnsResponse

Raises

ConnectionError HTTPException

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
csv_separator
string (Csv Separator)
Default: ";"
csv_decimal
string (Csv Decimal)
Default: "."
csv_encoding
string (Csv Encoding)
Default: "utf-8"
index_col
integer (Index Col)
Default: 0
datetime_template
any (DatetimeTemplates)
Enum: "year_month_day" "day_month_year" "month_day_year"

An enumeration.

datetime_format
string (Datetime Format)
timezone
string (Timezone)
token
required
string (Token)
Request Body schema: multipart/form-data
files
required
Array of strings <binary> (Files)

Responses

Response samples

Content type
application/json
{
  • "sensors": [
    ],
  • "dtypes": [
    ],
  • "index": "string",
  • "settings": {
    },
  • "data": { }
}

Get Data Inspection

Ingests csv files to database. For details, see docstring of the data_uploader module.

Parameters

plant_id : A pre-configured plant with this name must exist in the database. files : list List of csv files that are batch ingested. csv_separator : str Used in pd.read_csv as 'sep' kwarg csv_decimal : str Used in pd.read_csv as 'decimal' kwarg csv_encoding : str Used in pd.read_csv as 'encoding' kwarg index_col : int DataUploader will try to parse timestamps from this column. datetime_template : DatetimeTemplates Templates to simplify the definition of a datetime format. Overridden by datetime_format (if not None). datetime_format : str Used to parse timestamps from csv file. Leave to None infers the format. timezone : str or pytz.timezone. Optional. To be provided if timestamps in the data have no time zone information. response : fastapi.Response sess : sqlalchemy.orm.Session crd : api.dependencies.crud

Returns

upload_response : DataColumnsResponse

Raises

ConnectionError HTTPException

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
csv_separator
string (Csv Separator)
Default: ";"
csv_decimal
string (Csv Decimal)
Default: "."
csv_encoding
string (Csv Encoding)
Default: "utf-8"
index_col
integer (Index Col)
Default: 0
datetime_template
any (DatetimeTemplates)
Enum: "year_month_day" "day_month_year" "month_day_year"

An enumeration.

datetime_format
string (Datetime Format)
timezone
string (Timezone)
token
required
string (Token)
Request Body schema: multipart/form-data
files
required
Array of strings <binary> (Files)

Responses

Response samples

Content type
application/json
{
  • "sensors": [
    ],
  • "dtypes": [
    ],
  • "index": "string",
  • "settings": {
    },
  • "data": { }
}

Get historic data uploads of the plant

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a single entry of the data history by id

path Parameters
plant_id
required
integer (Plant Id)
history_id
required
integer (History Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

methods

Run the PC method

Runs the PC Method for the specified dates range

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
method
string (PCMethods)
Enum: "ISO" "extended"

An enumeration.

formula
integer (PCFormulae)
Enum: 1 2 3

An enumeration.

eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
ignore_wind
boolean (Ignore Wind)
safety_pipes
number (Safety Pipes)
safety_uncertainty
number (Safety Uncertainty)
safety_others
number (Safety Others)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "plant": {
    },
  • "datetime_eval_start": "2019-08-24T14:15:22Z",
  • "datetime_eval_end": "2019-08-24T14:15:22Z",
  • "pc_method_name": "string",
  • "evaluation_mode": "string",
  • "formula": 0,
  • "wind_used": true,
  • "settings": { },
  • "plant_output": {
    },
  • "array_output": [
    ]
}

Run the PC method and create a pdf report

Run the PC Method for the specified dates range and return a pdf report.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
method
string (PCMethods)
Enum: "ISO" "extended"

An enumeration.

formula
integer (PCFormulae)
Enum: 1 2 3

An enumeration.

eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
ignore_wind
boolean (Ignore Wind)
safety_pipes
number (Safety Pipes)
safety_uncertainty
number (Safety Uncertainty)
safety_others
number (Safety Others)
with_interval_plots
boolean (With Interval Plots)
include_creation_date
boolean (Include Creation Date)
anonymize
boolean (Anonymize)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Feedback about which PC method variants can be run with the given plant configuration

List problems for the PC Method for the specified dates range

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
method
string (PCMethods)
Enum: "ISO" "extended"

An enumeration.

formula
integer (PCFormulae)
Enum: 1 2 3

An enumeration.

ignore_wind
boolean (Ignore Wind)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Settings for the PC method

Get PC Method settings for given plant.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "safety_uncertainty": 0,
  • "safety_pipes": 0,
  • "safety_others": 0,
  • "evaluation_mode": "string",
  • "formula": 0,
  • "wind_used": true
}

Update Settings for the PC method

Update PC Method settings for given plant.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
safety_uncertainty
number (Safety Uncertainty)
safety_pipes
number (Safety Pipes)
safety_others
number (Safety Others)
evaluation_mode
string (Evaluation Mode)
formula
integer (Formula)
wind_used
boolean (Wind Used)

Responses

Request samples

Content type
application/json
{
  • "safety_uncertainty": 0,
  • "safety_pipes": 0,
  • "safety_others": 0,
  • "evaluation_mode": "string",
  • "formula": 0,
  • "wind_used": true
}

Response samples

Content type
application/json
{
  • "safety_uncertainty": 0,
  • "safety_pipes": 0,
  • "safety_others": 0,
  • "evaluation_mode": "string",
  • "formula": 0,
  • "wind_used": true
}

evaluations

Run the PC method

Runs the PC Method for the specified dates range

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
method
string (PCMethods)
Enum: "ISO" "extended"

An enumeration.

formula
integer (PCFormulae)
Enum: 1 2 3

An enumeration.

eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
ignore_wind
boolean (Ignore Wind)
safety_pipes
number (Safety Pipes)
safety_uncertainty
number (Safety Uncertainty)
safety_others
number (Safety Others)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "plant": {
    },
  • "datetime_eval_start": "2019-08-24T14:15:22Z",
  • "datetime_eval_end": "2019-08-24T14:15:22Z",
  • "pc_method_name": "string",
  • "evaluation_mode": "string",
  • "formula": 0,
  • "wind_used": true,
  • "settings": { },
  • "plant_output": {
    },
  • "array_output": [
    ]
}

Run the PC method and create a pdf report

Run the PC Method for the specified dates range and return a pdf report.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
method
string (PCMethods)
Enum: "ISO" "extended"

An enumeration.

formula
integer (PCFormulae)
Enum: 1 2 3

An enumeration.

eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
ignore_wind
boolean (Ignore Wind)
safety_pipes
number (Safety Pipes)
safety_uncertainty
number (Safety Uncertainty)
safety_others
number (Safety Others)
with_interval_plots
boolean (With Interval Plots)
include_creation_date
boolean (Include Creation Date)
anonymize
boolean (Anonymize)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Feedback about which PC method variants can be run with the given plant configuration

List problems for the PC Method for the specified dates range

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
method
string (PCMethods)
Enum: "ISO" "extended"

An enumeration.

formula
integer (PCFormulae)
Enum: 1 2 3

An enumeration.

ignore_wind
boolean (Ignore Wind)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Settings for the PC method

Get PC Method settings for given plant.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "safety_uncertainty": 0,
  • "safety_pipes": 0,
  • "safety_others": 0,
  • "evaluation_mode": "string",
  • "formula": 0,
  • "wind_used": true
}

Update Settings for the PC method

Update PC Method settings for given plant.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
safety_uncertainty
number (Safety Uncertainty)
safety_pipes
number (Safety Pipes)
safety_others
number (Safety Others)
evaluation_mode
string (Evaluation Mode)
formula
integer (Formula)
wind_used
boolean (Wind Used)

Responses

Request samples

Content type
application/json
{
  • "safety_uncertainty": 0,
  • "safety_pipes": 0,
  • "safety_others": 0,
  • "evaluation_mode": "string",
  • "formula": 0,
  • "wind_used": true
}

Response samples

Content type
application/json
{
  • "safety_uncertainty": 0,
  • "safety_pipes": 0,
  • "safety_others": 0,
  • "evaluation_mode": "string",
  • "formula": 0,
  • "wind_used": true
}

config

Ping Harvestit Old

old version for backward compatibility

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Ping Harvestit

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Ping Database

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get a list of sensor types, or select by id or name and plant

query Parameters
name
string (Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[ ]

Get a single list of fluid_definitions, or select by id or name and plant

query Parameters
id
integer (Id)
name
string (Name)
plant_id
integer (Plant Id)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "model_type": "string",
  • "name": "string",
  • "manufacturer": "string",
  • "description": "string",
  • "is_pure": true,
  • "dm_model_sha1": "string",
  • "hc_model_sha1": "string",
  • "heat_capacity_unit_te": "string",
  • "heat_capacity_unit_out": "string",
  • "heat_capacity_unit_c": "string",
  • "density_unit_te": "string",
  • "density_unit_out": "string",
  • "density_unit_c": "string"
}

Get a single fluid definition by id

path Parameters
id
required
integer (Id)
query Parameters
name
string (Name)
plant_id
integer (Plant Id)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "model_type": "string",
  • "name": "string",
  • "manufacturer": "string",
  • "description": "string",
  • "is_pure": true,
  • "dm_model_sha1": "string",
  • "hc_model_sha1": "string",
  • "heat_capacity_unit_te": "string",
  • "heat_capacity_unit_out": "string",
  • "heat_capacity_unit_c": "string",
  • "density_unit_te": "string",
  • "density_unit_out": "string",
  • "density_unit_c": "string"
}

Get a list of collectors, or select by id or name, or filter by collectors used in a specific plant.

query Parameters
id
integer (Id)
name
string (Name)
plant_id
integer (Plant Id)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "test_reference_area": "string",
  • "test_type": "string",
  • "gross_length": {
    },
  • "iam_method": {
    },
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "test_report_id": "string",
  • "licence_number": "string",
  • "certificate_date_issued": "2019-08-24T14:15:22Z",
  • "certificate_lab": "string",
  • "certificate_details": "string",
  • "collector_type": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "gross_width": {
    },
  • "gross_height": {
    },
  • "a1": {
    },
  • "a2": {
    },
  • "a5": {
    },
  • "a8": {
    },
  • "kd": {
    },
  • "eta0b": {
    },
  • "eta0hem": {
    },
  • "f_prime": {
    },
  • "concentration_ratio": {
    },
  • "calculation_info": {
    },
  • "aperture_parameters": {
    },
  • "id": 0
}

Create a new collector or collectors

query Parameters
token
required
string (Token)
Request Body schema: application/json
Any of
name
required
string (Name)
test_reference_area
required
string (Test Reference Area)
test_type
string (Test Type)
object (Quantity)
IAM_K50 (object) or IAM_ASHRAE (object) or IAM_Ambrosetti (object) or IAM_Interpolated (object) (Iam Method)
manufacturer_name
string (Manufacturer Name)
product_name
string (Product Name)
test_report_id
string (Test Report Id)
licence_number
string (Licence Number)
string or string (Certificate Date Issued)
certificate_lab
string (Certificate Lab)
certificate_details
string (Certificate Details)
collector_type
required
string (Collector Type)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
required
object (Quantity)
required
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Calculation Info)
object (ApertureParameters)
required
object (Quantity)

Responses

Request samples

Content type
application/json
Example
CollectorSST
CollectorSST
CollectorQDT
[ ]

Response samples

Content type
application/json
[ ]

Get a single collector by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "test_reference_area": "string",
  • "test_type": "string",
  • "gross_length": {
    },
  • "iam_method": {
    },
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "test_report_id": "string",
  • "licence_number": "string",
  • "certificate_date_issued": "2019-08-24T14:15:22Z",
  • "certificate_lab": "string",
  • "certificate_details": "string",
  • "collector_type": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "gross_width": {
    },
  • "gross_height": {
    },
  • "a1": {
    },
  • "a2": {
    },
  • "a5": {
    },
  • "a8": {
    },
  • "kd": {
    },
  • "eta0b": {
    },
  • "eta0hem": {
    },
  • "f_prime": {
    },
  • "concentration_ratio": {
    },
  • "calculation_info": {
    },
  • "aperture_parameters": {
    },
  • "id": 0
}

Update a collector

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
name
string (Name)
test_reference_area
required
string (Test Reference Area)
test_type
string (Test Type)
object (Quantity)
IAM_K50 (object) or IAM_ASHRAE (object) or IAM_Ambrosetti (object) or IAM_Interpolated (object) (Iam Method)
manufacturer_name
string (Manufacturer Name)
product_name
string (Product Name)
test_report_id
string (Test Report Id)
licence_number
string (Licence Number)
string or string (Certificate Date Issued)
certificate_lab
string (Certificate Lab)
certificate_details
string (Certificate Details)
collector_type
required
string (Collector Type)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
required
object (Quantity)
required
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Calculation Info)
object (ApertureParameters)
id
integer (Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "test_reference_area": "string",
  • "test_type": "string",
  • "gross_length": {
    },
  • "iam_method": {
    },
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "test_report_id": "string",
  • "licence_number": "string",
  • "certificate_date_issued": "2019-08-24T14:15:22Z",
  • "certificate_lab": "string",
  • "certificate_details": "string",
  • "collector_type": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "gross_width": {
    },
  • "gross_height": {
    },
  • "a1": {
    },
  • "a2": {
    },
  • "a5": {
    },
  • "a8": {
    },
  • "kd": {
    },
  • "eta0b": {
    },
  • "eta0hem": {
    },
  • "f_prime": {
    },
  • "concentration_ratio": {
    },
  • "calculation_info": {
    },
  • "aperture_parameters": {
    },
  • "id": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "test_reference_area": "string",
  • "test_type": "string",
  • "gross_length": {
    },
  • "iam_method": {
    },
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "test_report_id": "string",
  • "licence_number": "string",
  • "certificate_date_issued": "2019-08-24T14:15:22Z",
  • "certificate_lab": "string",
  • "certificate_details": "string",
  • "collector_type": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "gross_width": {
    },
  • "gross_height": {
    },
  • "a1": {
    },
  • "a2": {
    },
  • "a5": {
    },
  • "a8": {
    },
  • "kd": {
    },
  • "eta0b": {
    },
  • "eta0hem": {
    },
  • "f_prime": {
    },
  • "concentration_ratio": {
    },
  • "calculation_info": {
    },
  • "aperture_parameters": {
    }
}

Delete a single collector by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string",
  • "detail": "string"
}

Get a list of slot names to which sensors can be assigned for the given component type

query Parameters
component_type
required
any (cmp_types)
Enum: "plant" "array"

An enumeration.

include_virtuals
boolean (Include Virtuals)
Default: false
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

sensors

Get a list of sensor types, or select by id or name and plant

query Parameters
name
string (Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[ ]

Triggers calculation of the daily-summarized NaN report for all sensors.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "nan_report": {
    }
}

Get a single sensor by id

path Parameters
id
required
integer (Id)
required
integer or string (Plant Id)
query Parameters
raw_name
string (Raw Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Get a list of sensors, or select by id or raw name

path Parameters
required
integer or string (Plant Id)
query Parameters
id
integer (Id)
raw_name
string (Raw Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Delete multiple sensors by id

path Parameters
required
integer or string (Plant Id)
query Parameters
ids
Array of strings (Ids)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get measurement data of a single sensor by id

path Parameters
id
required
integer (Id)
required
integer or string (Plant Id)
query Parameters
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Create a new `Sensor` object or objects

Create a new sensor or sensors. raw_name is required. To create multiple sensors at once, pass a list of sensor structures

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
Any of
description
string (Description)
accuracy_class
string (AccuracyClass)
Enum: "low" "medium" "high"

An enumeration.

installation_condition
string (InstallCondition)
Enum: "perfect" "fair" "bad"

An enumeration.

info
object (Info)
Default: {}
raw_name
required
string (Raw Name)
native_unit
string (Native Unit)
sensor_type
string (Sensor Type)

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
[
  • {
    }
]

Get a single sensor by id

path Parameters
id
required
integer (Id)
query Parameters
raw_name
string (Raw Name)
integer or string (Plant Id)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Update a single sensor by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
description
string (Description)
accuracy_class
string (AccuracyClass)
Enum: "low" "medium" "high"

An enumeration.

installation_condition
string (InstallCondition)
Enum: "perfect" "fair" "bad"

An enumeration.

info
object (Info)
Default: {}
raw_name
string (Raw Name)
native_unit
string (Native Unit)
sensor_type
string (Sensor Type)
id
integer (Id)
plant_id
integer (Plant Id)
formatted_unit
string (Formatted Unit)
is_virtual
boolean (Is Virtual)
can_calculate
boolean (Can Calculate)
is_mapped
boolean (Is Mapped)
is_infos_set
boolean (Is Infos Set)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Delete a single sensor by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get measurement data of a single sensor by id

path Parameters
id
required
integer (Id)
query Parameters
integer or string (Plant Id)
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Batch update a list of sensors, each passed sensor object must contain an id

query Parameters
token
required
string (Token)
Request Body schema: application/json
Array
description
string (Description)
accuracy_class
string (AccuracyClass)
Enum: "low" "medium" "high"

An enumeration.

installation_condition
string (InstallCondition)
Enum: "perfect" "fair" "bad"

An enumeration.

info
object (Info)
Default: {}
raw_name
string (Raw Name)
native_unit
string (Native Unit)
sensor_type
string (Sensor Type)
id
required
integer (Id)
plant_id
integer (Plant Id)
formatted_unit
string (Formatted Unit)
is_virtual
boolean (Is Virtual)
can_calculate
boolean (Can Calculate)
is_mapped
boolean (Is Mapped)
is_infos_set
boolean (Is Infos Set)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

fluids

Get a single list of fluid_definitions, or select by id or name and plant

query Parameters
id
integer (Id)
name
string (Name)
plant_id
integer (Plant Id)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "model_type": "string",
  • "name": "string",
  • "manufacturer": "string",
  • "description": "string",
  • "is_pure": true,
  • "dm_model_sha1": "string",
  • "hc_model_sha1": "string",
  • "heat_capacity_unit_te": "string",
  • "heat_capacity_unit_out": "string",
  • "heat_capacity_unit_c": "string",
  • "density_unit_te": "string",
  • "density_unit_out": "string",
  • "density_unit_c": "string"
}

Get a single fluid definition by id

path Parameters
id
required
integer (Id)
query Parameters
name
string (Name)
plant_id
integer (Plant Id)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "model_type": "string",
  • "name": "string",
  • "manufacturer": "string",
  • "description": "string",
  • "is_pure": true,
  • "dm_model_sha1": "string",
  • "hc_model_sha1": "string",
  • "heat_capacity_unit_te": "string",
  • "heat_capacity_unit_out": "string",
  • "heat_capacity_unit_c": "string",
  • "density_unit_te": "string",
  • "density_unit_out": "string",
  • "density_unit_c": "string"
}

Get a list of fluids, or select by name

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
id
integer (Id)
name
string (Name)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "fluid": {
    },
  • "concentration": {
    }
}

Get a single fluid by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "fluid": {
    },
  • "concentration": {
    }
}

collectors

Get a list of collectors, or select by id or name, or filter by collectors used in a specific plant.

query Parameters
id
integer (Id)
name
string (Name)
plant_id
integer (Plant Id)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "test_reference_area": "string",
  • "test_type": "string",
  • "gross_length": {
    },
  • "iam_method": {
    },
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "test_report_id": "string",
  • "licence_number": "string",
  • "certificate_date_issued": "2019-08-24T14:15:22Z",
  • "certificate_lab": "string",
  • "certificate_details": "string",
  • "collector_type": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "gross_width": {
    },
  • "gross_height": {
    },
  • "a1": {
    },
  • "a2": {
    },
  • "a5": {
    },
  • "a8": {
    },
  • "kd": {
    },
  • "eta0b": {
    },
  • "eta0hem": {
    },
  • "f_prime": {
    },
  • "concentration_ratio": {
    },
  • "calculation_info": {
    },
  • "aperture_parameters": {
    },
  • "id": 0
}

Create a new collector or collectors

query Parameters
token
required
string (Token)
Request Body schema: application/json
Any of
name
required
string (Name)
test_reference_area
required
string (Test Reference Area)
test_type
string (Test Type)
object (Quantity)
IAM_K50 (object) or IAM_ASHRAE (object) or IAM_Ambrosetti (object) or IAM_Interpolated (object) (Iam Method)
manufacturer_name
string (Manufacturer Name)
product_name
string (Product Name)
test_report_id
string (Test Report Id)
licence_number
string (Licence Number)
string or string (Certificate Date Issued)
certificate_lab
string (Certificate Lab)
certificate_details
string (Certificate Details)
collector_type
required
string (Collector Type)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
required
object (Quantity)
required
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Calculation Info)
object (ApertureParameters)
required
object (Quantity)

Responses

Request samples

Content type
application/json
Example
CollectorSST
CollectorSST
CollectorQDT
[ ]

Response samples

Content type
application/json
[ ]

Get a single collector by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "test_reference_area": "string",
  • "test_type": "string",
  • "gross_length": {
    },
  • "iam_method": {
    },
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "test_report_id": "string",
  • "licence_number": "string",
  • "certificate_date_issued": "2019-08-24T14:15:22Z",
  • "certificate_lab": "string",
  • "certificate_details": "string",
  • "collector_type": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "gross_width": {
    },
  • "gross_height": {
    },
  • "a1": {
    },
  • "a2": {
    },
  • "a5": {
    },
  • "a8": {
    },
  • "kd": {
    },
  • "eta0b": {
    },
  • "eta0hem": {
    },
  • "f_prime": {
    },
  • "concentration_ratio": {
    },
  • "calculation_info": {
    },
  • "aperture_parameters": {
    },
  • "id": 0
}

Update a collector

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
name
string (Name)
test_reference_area
required
string (Test Reference Area)
test_type
string (Test Type)
object (Quantity)
IAM_K50 (object) or IAM_ASHRAE (object) or IAM_Ambrosetti (object) or IAM_Interpolated (object) (Iam Method)
manufacturer_name
string (Manufacturer Name)
product_name
string (Product Name)
test_report_id
string (Test Report Id)
licence_number
string (Licence Number)
string or string (Certificate Date Issued)
certificate_lab
string (Certificate Lab)
certificate_details
string (Certificate Details)
collector_type
required
string (Collector Type)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
required
object (Quantity)
required
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Calculation Info)
object (ApertureParameters)
id
integer (Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "test_reference_area": "string",
  • "test_type": "string",
  • "gross_length": {
    },
  • "iam_method": {
    },
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "test_report_id": "string",
  • "licence_number": "string",
  • "certificate_date_issued": "2019-08-24T14:15:22Z",
  • "certificate_lab": "string",
  • "certificate_details": "string",
  • "collector_type": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "gross_width": {
    },
  • "gross_height": {
    },
  • "a1": {
    },
  • "a2": {
    },
  • "a5": {
    },
  • "a8": {
    },
  • "kd": {
    },
  • "eta0b": {
    },
  • "eta0hem": {
    },
  • "f_prime": {
    },
  • "concentration_ratio": {
    },
  • "calculation_info": {
    },
  • "aperture_parameters": {
    },
  • "id": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "test_reference_area": "string",
  • "test_type": "string",
  • "gross_length": {
    },
  • "iam_method": {
    },
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "test_report_id": "string",
  • "licence_number": "string",
  • "certificate_date_issued": "2019-08-24T14:15:22Z",
  • "certificate_lab": "string",
  • "certificate_details": "string",
  • "collector_type": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "gross_width": {
    },
  • "gross_height": {
    },
  • "a1": {
    },
  • "a2": {
    },
  • "a5": {
    },
  • "a8": {
    },
  • "kd": {
    },
  • "eta0b": {
    },
  • "eta0hem": {
    },
  • "f_prime": {
    },
  • "concentration_ratio": {
    },
  • "calculation_info": {
    },
  • "aperture_parameters": {
    }
}

Delete a single collector by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string",
  • "detail": "string"
}

arrays

Get a list of slot names to which sensors can be assigned for the given component type

query Parameters
component_type
required
any (cmp_types)
Enum: "plant" "array"

An enumeration.

include_virtuals
boolean (Include Virtuals)
Default: false
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of arrays, or select by id or name and plant

path Parameters
required
integer or string (Plant Id)
query Parameters
id
integer (Id)
name
string (Name)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Get a list of arrays, or select by id or name and plant

Create a new array or arrays. name and collector are required. To create multiple arrays at once, pass a list of array structures. sensors can be mapped by passing a dict of sensor structures to sensors (NOTE not actually tested, may not work yet.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
sensor_map
object (Sensor Map)
id
integer (Id)
plant_id
integer (Plant Id)
name
required
string (Name)
collector
required
string (Collector)
object (Quantity)
object (Quantity)
required
object (Quantity)
required
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Sensors)

Responses

Request samples

Content type
application/json
{
  • "sensor_map": { },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    },
  • "sensors": {
    }
}

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Get a single array by id

path Parameters
id
required
integer (Id)
query Parameters
name
string (Name)
integer or string (Plant Id)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Update an array by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
object (Sensor Map)
id
integer (Id)
plant_id
integer (Plant Id)
name
string (Name)
collector
string (Collector)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)

Responses

Request samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Delete an array by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

plants

Get a list of slot names to which sensors can be assigned for the given component type

query Parameters
component_type
required
any (cmp_types)
Enum: "plant" "array"

An enumeration.

include_virtuals
boolean (Include Virtuals)
Default: false
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all plants

query Parameters
name
string (Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of all plants, with only minimal information

query Parameters
name
string (Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create plants

Create a new plant. name, latitude, longitude are required. sensors can be mapped by passing a list of sensor structures to sensors

query Parameters
token
required
string (Token)
Request Body schema: application/json
sensor_map
object (Sensor Map)
required
object (Quantity)
required
object (Quantity)
owner
string (Owner)
operator
string (Operator)
description
string (Description)
location_name
string (Location Name)
object (Quantity)
object (FluidSummary)
Array of objects (Arrays) [ items ]
object (Quantity)
Array of objects (Raw Sensors) [ items ]
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "sensor_map": { },
  • "latitude": {
    },
  • "longitude": {
    },
  • "owner": "string",
  • "operator": "string",
  • "description": "string",
  • "location_name": "string",
  • "elevation": {
    },
  • "fluid_solar": {
    },
  • "arrays": [
    ],
  • "fluidvol_total": {
    },
  • "raw_sensors": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "latitude": {
    },
  • "longitude": {
    },
  • "owner": "string",
  • "operator": "string",
  • "description": "string",
  • "location_name": "string",
  • "elevation": {
    },
  • "fluid_solar": {
    },
  • "arrays": [
    ],
  • "fluidvol_total": {
    },
  • "raw_sensors": [
    ],
  • "name": "string",
  • "id": 0,
  • "local_tz_string_with_DST": "string",
  • "tz_data_offset": 0,
  • "data_upload_defaults": {
    },
  • "virtuals_calculation_uptodate": true
}

Import a plant from JSON configuration, such as that returned by `plants/{plant_id}/export_config`

query Parameters
new_plant_name
string (New Plant Name)
token
required
string (Token)
Request Body schema: application/json
required
Array of objects (Collectors) [ items ]
required
Array of objects (Fluid Definitions) [ items ]
required
object (NewPlant)

Responses

Request samples

Content type
application/json
{
  • "collectors": [
    ],
  • "fluid_definitions": [
    ],
  • "plant": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Import a plant from JSON configuration, such as that returned by `plants/{plant_id}/export_config`

query Parameters
new_plant_name
string (New Plant Name)
token
required
string (Token)
Request Body schema: application/json
required
Array of objects (Collectors) [ items ]
required
Array of objects (Fluid Definitions) [ items ]
required
object (NewPlant)

Responses

Request samples

Content type
application/json
{
  • "collectors": [
    ],
  • "fluid_definitions": [
    ],
  • "plant": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Create demo plant config, optionally including data, if data is to be included, accept_license must also be set to true

query Parameters
name
string (Name)
include_data
boolean (Include Data)
Default: false
accept_license
boolean (Accept License)
Default: false
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "latitude": {
    },
  • "longitude": {
    },
  • "owner": "string",
  • "operator": "string",
  • "description": "string",
  • "location_name": "string",
  • "elevation": {
    },
  • "fluid_solar": {
    },
  • "arrays": [
    ],
  • "fluidvol_total": {
    },
  • "raw_sensors": [
    ],
  • "name": "string",
  • "id": 0,
  • "local_tz_string_with_DST": "string",
  • "tz_data_offset": 0,
  • "data_upload_defaults": {
    },
  • "virtuals_calculation_uptodate": true
}

Get a single plant by id

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "latitude": {
    },
  • "longitude": {
    },
  • "owner": "string",
  • "operator": "string",
  • "description": "string",
  • "location_name": "string",
  • "elevation": {
    },
  • "fluid_solar": {
    },
  • "arrays": [
    ],
  • "fluidvol_total": {
    },
  • "raw_sensors": [
    ],
  • "name": "string",
  • "id": 0,
  • "local_tz_string_with_DST": "string",
  • "tz_data_offset": 0,
  • "data_upload_defaults": {
    },
  • "virtuals_calculation_uptodate": true
}

Export a plant configuration, optionally with data

Export a plant with the sensor types, collector types, and fluid definitions it uses.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "collectors": [
    ],
  • "fluid_definitions": [
    ],
  • "plant": {
    }
}

Export a plant with configuration and data

Create an export job for a complete plant with sensor types, collector types, fluid definitions, and data. When the job completes a tar package containing a json file, and data 1 CSV file per calender year, is available for download

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
include_virtuals
boolean (Include Virtuals)
Default: true
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  • "href": "string"
}

sensor_slots

Get a list of slot names to which sensors can be assigned for the given component type

query Parameters
component_type
required
any (cmp_types)
Enum: "plant" "array"

An enumeration.

include_virtuals
boolean (Include Virtuals)
Default: false
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

export/import

Import a plant from JSON configuration, such as that returned by `plants/{plant_id}/export_config`

query Parameters
new_plant_name
string (New Plant Name)
token
required
string (Token)
Request Body schema: application/json
required
Array of objects (Collectors) [ items ]
required
Array of objects (Fluid Definitions) [ items ]
required
object (NewPlant)

Responses

Request samples

Content type
application/json
{
  • "collectors": [
    ],
  • "fluid_definitions": [
    ],
  • "plant": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Export a plant configuration, optionally with data

Export a plant with the sensor types, collector types, and fluid definitions it uses.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "collectors": [
    ],
  • "fluid_definitions": [
    ],
  • "plant": {
    }
}

Export a plant with configuration and data

Create an export job for a complete plant with sensor types, collector types, fluid definitions, and data. When the job completes a tar package containing a json file, and data 1 CSV file per calender year, is available for download

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
include_virtuals
boolean (Include Virtuals)
Default: true
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  • "href": "string"
}

plant

Get a plant summary, with only minimal information

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "owner": "string",
  • "operator": "string",
  • "description": "string",
  • "location_name": "string",
  • "latitude": {
    },
  • "longitude": {
    },
  • "elevation": {
    },
  • "id": 0,
  • "virtuals_calculation_uptodate": true
}

Update a plant

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
name
string (Name)
owner
string (Owner)
operator
string (Operator)
description
string (Description)
location_name
string (Location Name)
object (Quantity)
object (Quantity)
object (Quantity)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "owner": "string",
  • "operator": "string",
  • "description": "string",
  • "location_name": "string",
  • "latitude": {
    },
  • "longitude": {
    },
  • "elevation": {
    }
}

Response samples

Content type
application/json
[ ]

Get a single plant by id

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "latitude": {
    },
  • "longitude": {
    },
  • "owner": "string",
  • "operator": "string",
  • "description": "string",
  • "location_name": "string",
  • "elevation": {
    },
  • "fluid_solar": {
    },
  • "arrays": [
    ],
  • "fluidvol_total": {
    },
  • "raw_sensors": [
    ],
  • "name": "string",
  • "id": 0,
  • "local_tz_string_with_DST": "string",
  • "tz_data_offset": 0,
  • "data_upload_defaults": {
    },
  • "virtuals_calculation_uptodate": true
}

Update a plant

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
object (Sensor Map)
object (Quantity)
object (Quantity)
owner
string (Owner)
operator
string (Operator)
description
string (Description)
location_name
string (Location Name)
object (Quantity)
FluidSummary (object) or string (Fluid Solar)
Array of objects (Arrays) [ items ]
object (Quantity)
Array of objects (Raw Sensors) [ items ]
name
string (Name)
object (Sensors)
object (DataUploadDefaults)

Responses

Request samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "latitude": {
    },
  • "longitude": {
    },
  • "owner": "string",
  • "operator": "string",
  • "description": "string",
  • "location_name": "string",
  • "elevation": {
    },
  • "fluid_solar": {
    },
  • "arrays": [
    ],
  • "fluidvol_total": {
    },
  • "raw_sensors": [
    ],
  • "name": "string",
  • "sensors": {
    },
  • "data_upload_defaults": {
    }
}

Response samples

Content type
application/json
[ ]

Delete a plant by id

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Export a plant configuration, optionally with data

Export a plant with the sensor types, collector types, and fluid definitions it uses.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "collectors": [
    ],
  • "fluid_definitions": [
    ],
  • "plant": {
    }
}

Export a plant with configuration and data

Create an export job for a complete plant with sensor types, collector types, fluid definitions, and data. When the job completes a tar package containing a json file, and data 1 CSV file per calender year, is available for download

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
include_virtuals
boolean (Include Virtuals)
Default: true
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  • "href": "string"
}

Get timestamps when data associated with the plant start and end.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z"
}

Triggers calculation of the daily-summarized NaN report for all sensors.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "nan_report": {
    }
}

Triggers the recalculation of all virtual sensors of that plant

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get a single sensor by id

path Parameters
id
required
integer (Id)
required
integer or string (Plant Id)
query Parameters
raw_name
string (Raw Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Get a list of sensors, or select by id or raw name

path Parameters
required
integer or string (Plant Id)
query Parameters
id
integer (Id)
raw_name
string (Raw Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Delete multiple sensors by id

path Parameters
required
integer or string (Plant Id)
query Parameters
ids
Array of strings (Ids)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get measurement data of a single sensor by id

path Parameters
id
required
integer (Id)
required
integer or string (Plant Id)
query Parameters
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Create a new `Sensor` object or objects

Create a new sensor or sensors. raw_name is required. To create multiple sensors at once, pass a list of sensor structures

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
Any of
description
string (Description)
accuracy_class
string (AccuracyClass)
Enum: "low" "medium" "high"

An enumeration.

installation_condition
string (InstallCondition)
Enum: "perfect" "fair" "bad"

An enumeration.

info
object (Info)
Default: {}
raw_name
required
string (Raw Name)
native_unit
string (Native Unit)
sensor_type
string (Sensor Type)

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of arrays, or select by id or name and plant

path Parameters
required
integer or string (Plant Id)
query Parameters
id
integer (Id)
name
string (Name)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Get a list of arrays, or select by id or name and plant

Create a new array or arrays. name and collector are required. To create multiple arrays at once, pass a list of array structures. sensors can be mapped by passing a dict of sensor structures to sensors (NOTE not actually tested, may not work yet.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
sensor_map
object (Sensor Map)
id
integer (Id)
plant_id
integer (Plant Id)
name
required
string (Name)
collector
required
string (Collector)
object (Quantity)
object (Quantity)
required
object (Quantity)
required
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Sensors)

Responses

Request samples

Content type
application/json
{
  • "sensor_map": { },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    },
  • "sensors": {
    }
}

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Get a list of fluids, or select by name

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
id
integer (Id)
name
string (Name)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "fluid": {
    },
  • "concentration": {
    }
}

Get a single fluid by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "manufacturer_name": "string",
  • "product_name": "string",
  • "fluid": {
    },
  • "concentration": {
    }
}

Get a list of operational_events for a plant, or select by date range, or id

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
id
integer (Id)
search_start
string <date-time> (Search Start)
search_end
string <date-time> (Search End)
search_timezone
string (Search Timezone)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[ ]

Create an operational event

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
event_start
required
string <date-time> (Event Start)
timezone
required
string (Timezone)
event_end
string <date-time> (Event End)
description
string (Description)
ignored_range
boolean (Ignored Range)
Default: false
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "plant": "string",
  • "event_start": "2019-08-24T14:15:22Z",
  • "event_end": "2019-08-24T14:15:22Z",
  • "ignored_range": false,
  • "description": "string",
  • "original_timezone": "string"
}

Upload measurement data to plant

Ingests csv files to database. For details, see docstring of the data_uploader module.

Parameters

plant_id : A pre-configured plant with this name must exist in the database. files : list List of csv files that are batch ingested. datetime_template : DatetimeTemplates Templates to simplify the definition of a datetime format. Overridden by datetime_format (if not None). datetime_format : str Used to parse datetimes from csv file. Leave to None infers the format. timezone : str or pytz.timezone. Optional. To be provided if timestamps in the data have no time zone information. csv_separator : str Used in pd.read_csv as 'sep' kwarg csv_decimal : str Used in pd.read_csv as 'decimal' kwarg csv_encoding : str Used in pd.read_csv as 'encoding' kwarg index_col : int DataUploader will try to parse timestamps from this column. response : fastapi.Response sess : sqlalchemy.orm.Session crd : api.dependencies.crud

Returns

upload_response : DataUploadResponse

Raises

ConnectionError HTTPException

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
datetime_template
any (DatetimeTemplates)
Enum: "year_month_day" "day_month_year" "month_day_year"

An enumeration.

datetime_format
string (Datetime Format)
timezone
string (Timezone)
csv_separator
string (Csv Separator)
Default: ";"
csv_decimal
string (Csv Decimal)
Default: "."
csv_encoding
string (Csv Encoding)
Default: "utf-8"
index_col
integer (Index Col)
Default: 0
token
required
string (Token)
Request Body schema: multipart/form-data
files
required
Array of strings <binary> (Files)

Responses

Response samples

Content type
application/json
{
  • "n_uploaded_data_rows": 0,
  • "n_duplicates_index": 0,
  • "response_per_file": [
    ],
  • "db_response": { }
}

Delete measurement data from plant in given interval

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
start
required
string <date-time> (Start)
end
required
string <date-time> (End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Delete all data from plant

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get Data Inspection

Ingests csv files to database. For details, see docstring of the data_uploader module.

Parameters

plant_id : A pre-configured plant with this name must exist in the database. files : list List of csv files that are batch ingested. csv_separator : str Used in pd.read_csv as 'sep' kwarg csv_decimal : str Used in pd.read_csv as 'decimal' kwarg csv_encoding : str Used in pd.read_csv as 'encoding' kwarg index_col : int DataUploader will try to parse timestamps from this column. datetime_template : DatetimeTemplates Templates to simplify the definition of a datetime format. Overridden by datetime_format (if not None). datetime_format : str Used to parse timestamps from csv file. Leave to None infers the format. timezone : str or pytz.timezone. Optional. To be provided if timestamps in the data have no time zone information. response : fastapi.Response sess : sqlalchemy.orm.Session crd : api.dependencies.crud

Returns

upload_response : DataColumnsResponse

Raises

ConnectionError HTTPException

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
csv_separator
string (Csv Separator)
Default: ";"
csv_decimal
string (Csv Decimal)
Default: "."
csv_encoding
string (Csv Encoding)
Default: "utf-8"
index_col
integer (Index Col)
Default: 0
datetime_template
any (DatetimeTemplates)
Enum: "year_month_day" "day_month_year" "month_day_year"

An enumeration.

datetime_format
string (Datetime Format)
timezone
string (Timezone)
token
required
string (Token)
Request Body schema: multipart/form-data
files
required
Array of strings <binary> (Files)

Responses

Response samples

Content type
application/json
{
  • "sensors": [
    ],
  • "dtypes": [
    ],
  • "index": "string",
  • "settings": {
    },
  • "data": { }
}

Get Data Inspection

Ingests csv files to database. For details, see docstring of the data_uploader module.

Parameters

plant_id : A pre-configured plant with this name must exist in the database. files : list List of csv files that are batch ingested. csv_separator : str Used in pd.read_csv as 'sep' kwarg csv_decimal : str Used in pd.read_csv as 'decimal' kwarg csv_encoding : str Used in pd.read_csv as 'encoding' kwarg index_col : int DataUploader will try to parse timestamps from this column. datetime_template : DatetimeTemplates Templates to simplify the definition of a datetime format. Overridden by datetime_format (if not None). datetime_format : str Used to parse timestamps from csv file. Leave to None infers the format. timezone : str or pytz.timezone. Optional. To be provided if timestamps in the data have no time zone information. response : fastapi.Response sess : sqlalchemy.orm.Session crd : api.dependencies.crud

Returns

upload_response : DataColumnsResponse

Raises

ConnectionError HTTPException

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
csv_separator
string (Csv Separator)
Default: ";"
csv_decimal
string (Csv Decimal)
Default: "."
csv_encoding
string (Csv Encoding)
Default: "utf-8"
index_col
integer (Index Col)
Default: 0
datetime_template
any (DatetimeTemplates)
Enum: "year_month_day" "day_month_year" "month_day_year"

An enumeration.

datetime_format
string (Datetime Format)
timezone
string (Timezone)
token
required
string (Token)
Request Body schema: multipart/form-data
files
required
Array of strings <binary> (Files)

Responses

Response samples

Content type
application/json
{
  • "sensors": [
    ],
  • "dtypes": [
    ],
  • "index": "string",
  • "settings": {
    },
  • "data": { }
}

Get historic data uploads of the plant

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a single entry of the data history by id

path Parameters
plant_id
required
integer (Plant Id)
history_id
required
integer (History Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get a single sensor by id

path Parameters
id
required
integer (Id)
query Parameters
raw_name
string (Raw Name)
integer or string (Plant Id)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Update a single sensor by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
description
string (Description)
accuracy_class
string (AccuracyClass)
Enum: "low" "medium" "high"

An enumeration.

installation_condition
string (InstallCondition)
Enum: "perfect" "fair" "bad"

An enumeration.

info
object (Info)
Default: {}
raw_name
string (Raw Name)
native_unit
string (Native Unit)
sensor_type
string (Sensor Type)
id
integer (Id)
plant_id
integer (Plant Id)
formatted_unit
string (Formatted Unit)
is_virtual
boolean (Is Virtual)
can_calculate
boolean (Can Calculate)
is_mapped
boolean (Is Mapped)
is_infos_set
boolean (Is Infos Set)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Delete a single sensor by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Get measurement data of a single sensor by id

path Parameters
id
required
integer (Id)
query Parameters
integer or string (Plant Id)
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "accuracy_class": "low",
  • "installation_condition": "perfect",
  • "info": { },
  • "raw_name": "string",
  • "native_unit": "string",
  • "sensor_type": "string",
  • "id": 0,
  • "plant_id": 0,
  • "formatted_unit": "string",
  • "is_virtual": true,
  • "can_calculate": true,
  • "is_mapped": true,
  • "is_infos_set": true
}

Batch update a list of sensors, each passed sensor object must contain an id

query Parameters
token
required
string (Token)
Request Body schema: application/json
Array
description
string (Description)
accuracy_class
string (AccuracyClass)
Enum: "low" "medium" "high"

An enumeration.

installation_condition
string (InstallCondition)
Enum: "perfect" "fair" "bad"

An enumeration.

info
object (Info)
Default: {}
raw_name
string (Raw Name)
native_unit
string (Native Unit)
sensor_type
string (Sensor Type)
id
required
integer (Id)
plant_id
integer (Plant Id)
formatted_unit
string (Formatted Unit)
is_virtual
boolean (Is Virtual)
can_calculate
boolean (Can Calculate)
is_mapped
boolean (Is Mapped)
is_infos_set
boolean (Is Infos Set)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get a single array by id

path Parameters
id
required
integer (Id)
query Parameters
name
string (Name)
integer or string (Plant Id)
plant_name
string (Plant Name)
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Update an array by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)
Request Body schema: application/json
object (Sensor Map)
id
integer (Id)
plant_id
integer (Plant Id)
name
string (Name)
collector
string (Collector)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)
object (Quantity)

Responses

Request samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Response samples

Content type
application/json
{
  • "sensor_map": {
    },
  • "id": 0,
  • "plant_id": 0,
  • "name": "string",
  • "collector": "string",
  • "area_gr": {
    },
  • "area_ap": {
    },
  • "azim": {
    },
  • "tilt": {
    },
  • "row_spacing": {
    },
  • "n_rows": {
    },
  • "ground_tilt": {
    },
  • "mounting_level": {
    },
  • "fluidvol_total": {
    },
  • "rho_ground": {
    },
  • "rho_colbackside": {
    },
  • "rho_colsurface": {
    },
  • "max_aoi_shadow": {
    },
  • "min_elevation_shadow": {
    }
}

Delete an array by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

an operational event by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "plant": "string",
  • "event_start": "2019-08-24T14:15:22Z",
  • "event_end": "2019-08-24T14:15:22Z",
  • "ignored_range": false,
  • "description": "string",
  • "original_timezone": "string"
}

Delete an operational event by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Show a list of timezones, including plant local time without DST

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

interval

Get timestamps when data associated with the plant start and end.

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z"
}

sensors, virtual

Triggers the recalculation of all virtual sensors of that plant

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
eval_start
string <date-time> (Eval Start)
eval_end
string <date-time> (Eval End)
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

operational events

Get a list of operational_events for a plant, or select by date range, or id

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
id
integer (Id)
search_start
string <date-time> (Search Start)
search_end
string <date-time> (Search End)
search_timezone
string (Search Timezone)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[ ]

Create an operational event

path Parameters
plant_id
required
integer (Plant Id)
query Parameters
event_start
required
string <date-time> (Event Start)
timezone
required
string (Timezone)
event_end
string <date-time> (Event End)
description
string (Description)
ignored_range
boolean (Ignored Range)
Default: false
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "plant": "string",
  • "event_start": "2019-08-24T14:15:22Z",
  • "event_end": "2019-08-24T14:15:22Z",
  • "ignored_range": false,
  • "description": "string",
  • "original_timezone": "string"
}

an operational event by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "plant": "string",
  • "event_start": "2019-08-24T14:15:22Z",
  • "event_end": "2019-08-24T14:15:22Z",
  • "ignored_range": false,
  • "description": "string",
  • "original_timezone": "string"
}

Delete an operational event by id

path Parameters
id
required
integer (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

jobs

Get a job by id

path Parameters
id
required
string <uuid> (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "pending",
  • "result_url": "string",
  • "plant": "string"
}

List all jobs, or get one by id

query Parameters
id
string <uuid> (Id)
token
required
string (Token)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a job result by id

path Parameters
id
required
string <uuid> (Id)
query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string",
  • "detail": "string"
}

About

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

debug

About

query Parameters
include_plants
boolean (Include Plants)
Default: true
include_db_structure
boolean (Include Db Structure)
Default: true
token
required
string (Token)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string",
  • "detail": "string"
}

info

Show a list of timezones, including plant local time without DST

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

timezones

Show a list of timezones, including plant local time without DST

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null