Definitions
Get all definitions or filter by enum type
Overview
This request calls the PlantPredict API Definitions endpoint to retrieve the list of available model definitions.
Ensure these variables are correctly set in the active environment before sending the request.
Typical Use Cases
-
Retrieve available model definitions before creating a new project.
-
Look up model definitions prior to updating an existing project.
-
Inspect available model types and their identifiers for client-side validation or UI population.
Successful Response (High-Level)
A successful response returns an array of definition objects, each typically including:
-
A unique ID for the definition.
-
A human-readable name.
-
Additional metadata describing the model definition and how it can be used in projects.
GET
/
Definitions
Get all definitions or filter by enum type
curl --request GET \
--url https://api.plantpredict.terabase.energy/Definitions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.plantpredict.terabase.energy/Definitions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.plantpredict.terabase.energy/Definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plantpredict.terabase.energy/Definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.plantpredict.terabase.energy/Definitions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.plantpredict.terabase.energy/Definitions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plantpredict.terabase.energy/Definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"type": "AirMassModelType",
"values": [
{
"id": 0,
"name": "Bird-Hulstrom"
},
{
"id": 1,
"name": "Kasten-Sandia"
}
]
},
{
"type": "AshraeVersionEnum",
"values": [
{
"id": 0,
"name": "Version_2013"
},
{
"id": 1,
"name": "Version_2021"
}
]
},
{
"type": "Axis",
"values": [
{
"id": 0,
"name": "X"
},
{
"id": 1,
"name": "Y"
},
{
"id": 2,
"name": "Z"
}
]
},
{
"type": "BatchStepVariableTypeEnum",
"values": [
{
"id": 1,
"name": "DCAC Ratio"
},
{
"id": 2,
"name": "GCR"
},
{
"id": 3,
"name": "Tilt Angle"
},
{
"id": 4,
"name": "Azimuth"
},
{
"id": 5,
"name": "Post Height"
}
]
},
{
"type": "BOSInputMethod",
"values": [
{
"id": 0,
"name": "Manual Input"
},
{
"id": 1,
"name": "BOS Calculation"
}
]
},
{
"type": "CellDesignType",
"values": [
{
"id": 0,
"name": "Full Cell Technology"
},
{
"id": 1,
"name": "Half Cell Technology"
},
{
"id": 2,
"name": "N/A"
},
{
"id": 3,
"name": "None Specified"
}
]
},
{
"type": "CellTechnologyTypeEnum",
"values": [
{
"id": 1,
"name": "n-type mono c-Si"
},
{
"id": 2,
"name": "p-type mono c-Si PERC"
},
{
"id": 3,
"name": "p-type mono c-Si BSF"
},
{
"id": 4,
"name": "poly c-Si PERC"
},
{
"id": 5,
"name": "poly c-Si BSF"
},
{
"id": 6,
"name": "CdTe"
},
{
"id": 7,
"name": "CIGS"
},
{
"id": 8,
"name": "Mixed"
}
]
},
{
"type": "ConstructionTypeEnum",
"values": [
{
"id": 1,
"name": "Glass-Glass"
},
{
"id": 2,
"name": "Glass-Backsheet"
}
]
},
{
"type": "DataSourceType",
"values": [
{
"id": 1,
"name": "Manufacturer"
},
{
"id": 2,
"name": "PVsyst"
},
{
"id": 3,
"name": "University of Geneva"
},
{
"id": 4,
"name": "Photon"
},
{
"id": 5,
"name": "Sandia Database"
},
{
"id": 6,
"name": "Custom"
},
{
"id": 7,
"name": "PlantPredict"
}
]
},
{
"type": "DCFieldBacktrackingType",
"values": [
{
"id": 0,
"name": "True-Tracking"
},
{
"id": 1,
"name": "Backtracking"
},
{
"id": 2,
"name": "Time-Series"
}
]
},
{
"type": "DCFieldObjectSide",
"values": [
{
"id": 1,
"name": "One"
},
{
"id": 2,
"name": "Two"
},
{
"id": 3,
"name": "Three"
},
{
"id": 4,
"name": "Four"
}
]
},
{
"type": "DCFieldTrackingTypeEnum",
"values": [
{
"id": 0,
"name": "Fixed Tilt"
},
{
"id": 1,
"name": "Horizontal Tracker"
},
{
"id": 2,
"name": "Seasonal Tilt"
}
]
},
{
"type": "DefaultDCFieldBacktrackingType",
"values": [
{
"id": 0,
"name": "True-Tracking"
},
{
"id": 1,
"name": "Backtracking"
}
]
},
{
"type": "DefaultDegradation",
"values": [
{
"id": 0,
"name": "Module Defined"
},
{
"id": 1,
"name": "Fixed Degredation Rate"
}
]
},
{
"type": "DegradationModel",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Stepped AC"
},
{
"id": 2,
"name": "Linear AC"
},
{
"id": 3,
"name": "Linear DC"
},
{
"id": 4,
"name": "Non-Linear DC"
}
]
},
{
"type": "DiffuseDirectDecompModelType",
"values": [
{
"id": 0,
"name": "Erbs"
},
{
"id": 1,
"name": "Reindl"
},
{
"id": 2,
"name": "DIRINT"
},
{
"id": 3,
"name": "None"
}
]
},
{
"type": "DiffuseShadingModel",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Schaar-Panchula"
}
]
},
{
"type": "DirectBeamShadingModel",
"values": [
{
"id": 0,
"name": "Linear"
},
{
"id": 1,
"name": "None"
},
{
"id": 2,
"name": "2 Dimension (retired)"
},
{
"id": 3,
"name": "Fractional Electrical Shading"
},
{
"id": 5,
"name": "Module File Defined Shading"
}
]
},
{
"type": "EnergyInputMethod",
"values": [
{
"id": 0,
"name": "Manual Input"
},
{
"id": 1,
"name": "Map Extrapolation"
},
{
"id": 2,
"name": "Model 8760"
}
]
},
{
"type": "EntityType",
"values": [
{
"id": 1,
"name": "Project"
},
{
"id": 2,
"name": "Module"
},
{
"id": 3,
"name": "Inverter"
},
{
"id": 4,
"name": "Weather"
},
{
"id": 5,
"name": "Prediction"
},
{
"id": 6,
"name": "MultiJunction"
}
]
},
{
"type": "ESSChargeAlgorithm",
"values": [
{
"id": 0,
"name": "LGIA Excess"
},
{
"id": 1,
"name": "Energy Available"
},
{
"id": 2,
"name": "Custom"
}
]
},
{
"type": "ESSDispatchCustomCommand",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Discharge"
},
{
"id": 2,
"name": "Charge"
}
]
},
{
"type": "EvalType",
"values": [
{
"id": 0,
"name": "FieldEval"
},
{
"id": 1,
"name": "GroupEval"
},
{
"id": 2,
"name": "TabRepeat"
}
]
},
{
"type": "FacialityEnum",
"values": [
{
"id": 0,
"name": "Monofacial"
},
{
"id": 1,
"name": "Bifacial"
}
]
},
{
"type": "IncidenceAngleModelType",
"values": [
{
"id": 2,
"name": "Sandia"
},
{
"id": 3,
"name": "ASHRAE"
},
{
"id": 4,
"name": "None"
},
{
"id": 5,
"name": "Tabular IAM"
}
]
},
{
"type": "InverterType",
"values": [
{
"id": 0,
"name": "Unspecified"
},
{
"id": 1,
"name": "String"
},
{
"id": 2,
"name": "Central"
}
]
},
{
"type": "JunctionType",
"values": [
{
"id": 0,
"name": "Parallel"
},
{
"id": 1,
"name": "Series"
}
]
},
{
"type": "LibraryStatusEnum",
"values": [
{
"id": 0,
"name": "Unknown"
},
{
"id": 1,
"name": "Draft-Private"
},
{
"id": 2,
"name": "Draft-Shared"
},
{
"id": 3,
"name": "Active"
},
{
"id": 4,
"name": "Retired"
},
{
"id": 5,
"name": "Global"
},
{
"id": 6,
"name": "Global-Retired"
}
]
},
{
"type": "MapBuilderCreateDCOptions",
"values": [
{
"id": 0,
"name": "Arrays"
},
{
"id": 1,
"name": "Tables"
}
]
},
{
"type": "MarionDiffuseRegions",
"values": [
{
"id": 0,
"name": "Sky"
},
{
"id": 1,
"name": "Ground"
}
]
},
{
"type": "MessageType",
"values": [
{
"id": 1,
"name": "Error"
},
{
"id": 2,
"name": "Warning"
},
{
"id": 3,
"name": "Info"
},
{
"id": 4,
"name": "Debug"
}
]
},
{
"type": "MessageTypeEnum",
"values": [
{
"id": 0,
"name": "Prediction"
},
{
"id": 1,
"name": "Report"
}
]
},
{
"type": "ModuleDegradationModel",
"values": [
{
"id": 0,
"name": "Unspecified"
},
{
"id": 1,
"name": "Linear"
},
{
"id": 2,
"name": "Non-Linear"
}
]
},
{
"type": "ModuleDurability",
"values": [
{
"id": 0,
"name": "Standard"
},
{
"id": 1,
"name": "Quality"
},
{
"id": 2,
"name": "High"
}
]
},
{
"type": "ModuleOrientation",
"values": [
{
"id": 0,
"name": "Landscape"
},
{
"id": 1,
"name": "Portrait"
}
]
},
{
"type": "ModuleShadingResponse",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Linear"
},
{
"id": 2,
"name": "Fractional Electrical Shading"
}
]
},
{
"type": "ModuleTemperatureModelType",
"values": [
{
"id": 0,
"name": "Heat Balance"
},
{
"id": 1,
"name": "Sandia"
}
]
},
{
"type": "NSRDBRegions",
"values": [
{
"id": 0,
"name": "USA"
},
{
"id": 1,
"name": "Mexico"
},
{
"id": 2,
"name": "Americas"
},
{
"id": 3,
"name": "Europe"
},
{
"id": 4,
"name": "Africa"
},
{
"id": 5,
"name": "Asia"
},
{
"id": 6,
"name": "South_Asia"
},
{
"id": 7,
"name": "Australia_Pacific"
}
]
},
{
"type": "PowerPlantDesignType",
"values": [
{
"id": 0,
"name": "Simple"
},
{
"id": 1,
"name": "Advanced"
}
]
},
{
"type": "PredictionItemStatisticsTrackingTypeEnum",
"values": [
{
"id": 0,
"name": "Fixed Tilt"
},
{
"id": 1,
"name": "Horizontal Tracker"
},
{
"id": 2,
"name": "Seasonal Tilt"
},
{
"id": 3,
"name": "Mixed"
}
]
},
{
"type": "PredictionProcessingStep",
"values": [
{
"id": 0,
"name": "Unknown"
},
{
"id": 1,
"name": "None"
},
{
"id": 2,
"name": "InitializeFromDatabase"
},
{
"id": 3,
"name": "PrePrediction"
},
{
"id": 4,
"name": "PreparePrediction"
},
{
"id": 5,
"name": "PrepareWeather"
},
{
"id": 6,
"name": "PrepareWeatherDetail"
},
{
"id": 7,
"name": "ExecuteDiffuseDecompModel"
},
{
"id": 8,
"name": "PreparePowerPlant"
},
{
"id": 9,
"name": "PrepareBlocks"
},
{
"id": 10,
"name": "PrepareArrays"
},
{
"id": 11,
"name": "PrepareInverters"
},
{
"id": 12,
"name": "PrepareDCFields"
},
{
"id": 13,
"name": "PrepareModules"
},
{
"id": 14,
"name": "InitializeResults"
},
{
"id": 15,
"name": "MainPrediction"
},
{
"id": 16,
"name": "MainOuterPredictionLoop"
},
{
"id": 17,
"name": "FormattingWeatherFileForMultiYear"
},
{
"id": 18,
"name": "DCFieldCalculationLogic"
},
{
"id": 19,
"name": "InverterCalculationLogic"
},
{
"id": 20,
"name": "ArrayCalculationLogic"
},
{
"id": 21,
"name": "BlockCalculationLogic"
},
{
"id": 22,
"name": "PowerPlantCalculationLogic"
},
{
"id": 23,
"name": "ESSCalculationLogic"
},
{
"id": 24,
"name": "StructureShadingLogic"
},
{
"id": 25,
"name": "AggregateResults"
},
{
"id": 26,
"name": "PostPrediction"
},
{
"id": 27,
"name": "CalculatePredictionParameters"
},
{
"id": 28,
"name": "CalculatePlantCharactersitics"
},
{
"id": 29,
"name": "CalculateLocationParameters"
},
{
"id": 30,
"name": "CalculateResultSummary"
},
{
"id": 31,
"name": "CalculateBlockResultSummaries"
},
{
"id": 32,
"name": "CalculateDetailedOutputs"
},
{
"id": 33,
"name": "StoreResults"
},
{
"id": 34,
"name": "HandleNodalData"
},
{
"id": 35,
"name": "ExportCSV"
},
{
"id": 36,
"name": "ExportJSON"
},
{
"id": 37,
"name": "CreatePredictionStatistics"
},
{
"id": 38,
"name": "Completed"
}
]
},
{
"type": "PredictionStatusEnum",
"values": [
{
"id": 1,
"name": "Draft-Private"
},
{
"id": 2,
"name": "Draft-Shared"
},
{
"id": 3,
"name": "Analysis"
},
{
"id": 4,
"name": "Bid"
},
{
"id": 5,
"name": "Contract"
},
{
"id": 6,
"name": "Development"
},
{
"id": 7,
"name": "As Built"
},
{
"id": 8,
"name": "Warranty"
},
{
"id": 9,
"name": "Archived"
}
]
},
{
"type": "PredictionVersionEnum",
"values": [
{
"id": 3,
"name": "Version 3"
},
{
"id": 4,
"name": "Version 4"
},
{
"id": 5,
"name": "Version 5"
},
{
"id": 6,
"name": "Version 6"
},
{
"id": 7,
"name": "Version 7"
},
{
"id": 8,
"name": "Version 8"
},
{
"id": 9,
"name": "Version 9"
},
{
"id": 10,
"name": "Version 10"
}
]
},
{
"type": "ProcessingStatusEnum",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Queued"
},
{
"id": 2,
"name": "Running"
},
{
"id": 3,
"name": "Success"
},
{
"id": 4,
"name": "Error"
},
{
"id": 5,
"name": "Cancelled"
}
]
},
{
"type": "ProjectStatusEnum",
"values": [
{
"id": 0,
"name": "Active"
},
{
"id": 1,
"name": "Archived"
},
{
"id": 2,
"name": "StringSize"
}
]
},
{
"type": "PvModelType",
"values": [
{
"id": 0,
"name": "1-Diode Recombination"
},
{
"id": 1,
"name": "1-Diode"
},
{
"id": 3,
"name": "1-Diode Recombination Non-Linear Temp"
}
]
},
{
"type": "ResponseMessageType",
"values": [
{
"id": 0,
"name": "Info"
},
{
"id": 1,
"name": "Warning"
},
{
"id": 2,
"name": "Error"
}
]
},
{
"type": "RevenueType",
"values": [
{
"id": 0,
"name": "PPA"
},
{
"id": 1,
"name": "Merchant"
}
]
},
{
"type": "ShadeAlgorithm",
"values": [
{
"id": 0,
"name": "2D(default)"
},
{
"id": 1,
"name": "Infinite Rows"
},
{
"id": 2,
"name": "3D"
}
]
},
{
"type": "SoilingModelType",
"values": [
{
"id": 0,
"name": "Constant Monthly"
},
{
"id": 1,
"name": "Weather File"
},
{
"id": 2,
"name": "None"
}
]
},
{
"type": "SolarGISVersion",
"values": [
{
"id": 0,
"name": "PVPlanner"
},
{
"id": 1,
"name": "TMY15"
},
{
"id": 2,
"name": "TMY60"
}
]
},
{
"type": "SpectralResponseEnum",
"values": [
{
"id": 0,
"name": "No Spectral Shift"
},
{
"id": 1,
"name": "FS Series 4 & Earlier"
},
{
"id": 2,
"name": "FS Series 4-2 & Later"
},
{
"id": 3,
"name": "Sandia"
}
]
},
{
"type": "SpectralShiftModel",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "1-Param Pwat or Sandia"
},
{
"id": 2,
"name": "2-Param Pwat and AM"
},
{
"id": 3,
"name": "Monthly Override"
}
]
},
{
"type": "SpectralWeatherType",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Ngan-PWat"
},
{
"id": 2,
"name": "Ngan-RH"
},
{
"id": 3,
"name": "Ngan-Dewpoint"
}
]
},
{
"type": "TableType",
"values": [
{
"id": 0,
"name": "Flat"
},
{
"id": 1,
"name": "Sloped"
}
]
},
{
"type": "TimeSeriesType",
"values": [
{
"id": 0,
"name": "InverterSetPoint"
},
{
"id": 1,
"name": "InverterDerate"
},
{
"id": 2,
"name": "TrackingAngle"
},
{
"id": 3,
"name": "ModuleSurfaceTemperature"
},
{
"id": 4,
"name": "LGIALimit"
},
{
"id": 5,
"name": "IMPPAdjustment"
},
{
"id": 6,
"name": "VMPPAdjustment"
}
]
},
{
"type": "TranspositionModelType",
"values": [
{
"id": 0,
"name": "Hay"
},
{
"id": 1,
"name": "Perez"
}
]
},
{
"type": "UserStatusEnum",
"values": [
{
"id": 0,
"name": "Disabled"
},
{
"id": 1,
"name": "Active"
},
{
"id": 2,
"name": "Pending"
},
{
"id": 3,
"name": "Archived"
}
]
},
{
"type": "WeatherDataProvider",
"values": [
{
"id": 1,
"name": "NREL"
},
{
"id": 2,
"name": "AWS Truepower"
},
{
"id": 3,
"name": "WindLogics"
},
{
"id": 4,
"name": "Meteonorm"
},
{
"id": 5,
"name": "3TIER"
},
{
"id": 6,
"name": "Clean Power Research"
},
{
"id": 7,
"name": "GeoModel Solar"
},
{
"id": 8,
"name": "GeoSUN Africa"
},
{
"id": 9,
"name": "SoDa"
},
{
"id": 10,
"name": "HelioClim"
},
{
"id": 11,
"name": "Solar Resource Assessment"
},
{
"id": 12,
"name": "EnergyPlus"
},
{
"id": 13,
"name": "Other"
},
{
"id": 14,
"name": "Customer"
},
{
"id": 15,
"name": "Solar Prospector"
},
{
"id": 16,
"name": "GlobalFED"
},
{
"id": 17,
"name": "NSRDB"
},
{
"id": 18,
"name": "WhiteBox Technologies"
},
{
"id": 19,
"name": "SolarGIS"
},
{
"id": 20,
"name": "NASA"
},
{
"id": 21,
"name": "3TIER/Vaisala"
},
{
"id": 22,
"name": "Solcast"
}
]
},
{
"type": "WeatherDataType",
"values": [
{
"id": 0,
"name": "Synthetic Monthly"
},
{
"id": 1,
"name": "Satellite"
},
{
"id": 2,
"name": "Ground Corrected"
},
{
"id": 3,
"name": "Measured"
},
{
"id": 4,
"name": "TMY3"
},
{
"id": 5,
"name": "TGY"
},
{
"id": 6,
"name": "TMY"
},
{
"id": 7,
"name": "PSM"
},
{
"id": 8,
"name": "SUNY"
},
{
"id": 9,
"name": "MTS2"
},
{
"id": 10,
"name": "CZ2010"
}
]
},
{
"type": "WeatherFileColumnTypeEnum",
"values": [
{
"id": 1,
"name": "GHI"
},
{
"id": 2,
"name": "DNI"
},
{
"id": 3,
"name": "DHI"
},
{
"id": 4,
"name": "TEMP"
},
{
"id": 5,
"name": "Windspeed"
},
{
"id": 6,
"name": "RelativeHumidity"
},
{
"id": 7,
"name": "PWAT"
},
{
"id": 8,
"name": "Rain"
},
{
"id": 9,
"name": "Pressure"
},
{
"id": 10,
"name": "DewpointTemp"
},
{
"id": 11,
"name": "WindDirection"
},
{
"id": 12,
"name": "SoilingLoss"
},
{
"id": 13,
"name": "POAI"
}
]
},
{
"type": "WeatherFormat",
"values": [
{
"id": 1,
"name": "Solar Prospector CSV"
},
{
"id": 2,
"name": "NREL TMY3"
},
{
"id": 3,
"name": "Meteonorm TMY3"
},
{
"id": 4,
"name": "3Tier"
},
{
"id": 5,
"name": "AWS"
},
{
"id": 6,
"name": "EPW"
},
{
"id": 7,
"name": "GeoModel Solar"
},
{
"id": 8,
"name": "Clean Power Research"
},
{
"id": 9,
"name": "PlantPredict"
},
{
"id": 10,
"name": "TMY3"
},
{
"id": 11,
"name": "SolarGIS"
},
{
"id": 12,
"name": "NASA"
},
{
"id": 13,
"name": "3Tier/Vaisala"
},
{
"id": 14,
"name": "Solcast"
}
]
},
{
"type": "WeatherPLevel",
"values": [
{
"id": 0,
"name": "P50"
},
{
"id": 1,
"name": "P90"
},
{
"id": 2,
"name": "N/A"
},
{
"id": 3,
"name": "P95"
},
{
"id": 4,
"name": "P99"
},
{
"id": 5,
"name": "P75"
}
]
},
{
"type": "WeatherSourceTypeAPIEnum",
"values": [
{
"id": 0,
"name": "Unknown"
},
{
"id": 1,
"name": "Meteonorm"
},
{
"id": 2,
"name": "CPR-SolarAnywhere"
},
{
"id": 3,
"name": "NSRDB PSM"
},
{
"id": 4,
"name": "NSRDB SUNY"
},
{
"id": 5,
"name": "NSRDB MTS2"
},
{
"id": 6,
"name": "SolarGIS"
},
{
"id": 7,
"name": "NASA"
},
{
"id": 8,
"name": "Solcast"
}
]
},
{
"type": "WeatherTimestampDefinitionEnum",
"values": [
{
"id": 0,
"name": "Undefined"
},
{
"id": 1,
"name": "IntervalEnd"
},
{
"id": 2,
"name": "IntervalBegin"
},
{
"id": 3,
"name": "IntervalMiddle"
}
]
}
]
Authorizations
Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.
Query Parameters
Enum type name (e.g. CellTechnologyTypeEnum). Omit to return all.
⌘I
Get all definitions or filter by enum type
curl --request GET \
--url https://api.plantpredict.terabase.energy/Definitions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.plantpredict.terabase.energy/Definitions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.plantpredict.terabase.energy/Definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plantpredict.terabase.energy/Definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.plantpredict.terabase.energy/Definitions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.plantpredict.terabase.energy/Definitions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plantpredict.terabase.energy/Definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"type": "AirMassModelType",
"values": [
{
"id": 0,
"name": "Bird-Hulstrom"
},
{
"id": 1,
"name": "Kasten-Sandia"
}
]
},
{
"type": "AshraeVersionEnum",
"values": [
{
"id": 0,
"name": "Version_2013"
},
{
"id": 1,
"name": "Version_2021"
}
]
},
{
"type": "Axis",
"values": [
{
"id": 0,
"name": "X"
},
{
"id": 1,
"name": "Y"
},
{
"id": 2,
"name": "Z"
}
]
},
{
"type": "BatchStepVariableTypeEnum",
"values": [
{
"id": 1,
"name": "DCAC Ratio"
},
{
"id": 2,
"name": "GCR"
},
{
"id": 3,
"name": "Tilt Angle"
},
{
"id": 4,
"name": "Azimuth"
},
{
"id": 5,
"name": "Post Height"
}
]
},
{
"type": "BOSInputMethod",
"values": [
{
"id": 0,
"name": "Manual Input"
},
{
"id": 1,
"name": "BOS Calculation"
}
]
},
{
"type": "CellDesignType",
"values": [
{
"id": 0,
"name": "Full Cell Technology"
},
{
"id": 1,
"name": "Half Cell Technology"
},
{
"id": 2,
"name": "N/A"
},
{
"id": 3,
"name": "None Specified"
}
]
},
{
"type": "CellTechnologyTypeEnum",
"values": [
{
"id": 1,
"name": "n-type mono c-Si"
},
{
"id": 2,
"name": "p-type mono c-Si PERC"
},
{
"id": 3,
"name": "p-type mono c-Si BSF"
},
{
"id": 4,
"name": "poly c-Si PERC"
},
{
"id": 5,
"name": "poly c-Si BSF"
},
{
"id": 6,
"name": "CdTe"
},
{
"id": 7,
"name": "CIGS"
},
{
"id": 8,
"name": "Mixed"
}
]
},
{
"type": "ConstructionTypeEnum",
"values": [
{
"id": 1,
"name": "Glass-Glass"
},
{
"id": 2,
"name": "Glass-Backsheet"
}
]
},
{
"type": "DataSourceType",
"values": [
{
"id": 1,
"name": "Manufacturer"
},
{
"id": 2,
"name": "PVsyst"
},
{
"id": 3,
"name": "University of Geneva"
},
{
"id": 4,
"name": "Photon"
},
{
"id": 5,
"name": "Sandia Database"
},
{
"id": 6,
"name": "Custom"
},
{
"id": 7,
"name": "PlantPredict"
}
]
},
{
"type": "DCFieldBacktrackingType",
"values": [
{
"id": 0,
"name": "True-Tracking"
},
{
"id": 1,
"name": "Backtracking"
},
{
"id": 2,
"name": "Time-Series"
}
]
},
{
"type": "DCFieldObjectSide",
"values": [
{
"id": 1,
"name": "One"
},
{
"id": 2,
"name": "Two"
},
{
"id": 3,
"name": "Three"
},
{
"id": 4,
"name": "Four"
}
]
},
{
"type": "DCFieldTrackingTypeEnum",
"values": [
{
"id": 0,
"name": "Fixed Tilt"
},
{
"id": 1,
"name": "Horizontal Tracker"
},
{
"id": 2,
"name": "Seasonal Tilt"
}
]
},
{
"type": "DefaultDCFieldBacktrackingType",
"values": [
{
"id": 0,
"name": "True-Tracking"
},
{
"id": 1,
"name": "Backtracking"
}
]
},
{
"type": "DefaultDegradation",
"values": [
{
"id": 0,
"name": "Module Defined"
},
{
"id": 1,
"name": "Fixed Degredation Rate"
}
]
},
{
"type": "DegradationModel",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Stepped AC"
},
{
"id": 2,
"name": "Linear AC"
},
{
"id": 3,
"name": "Linear DC"
},
{
"id": 4,
"name": "Non-Linear DC"
}
]
},
{
"type": "DiffuseDirectDecompModelType",
"values": [
{
"id": 0,
"name": "Erbs"
},
{
"id": 1,
"name": "Reindl"
},
{
"id": 2,
"name": "DIRINT"
},
{
"id": 3,
"name": "None"
}
]
},
{
"type": "DiffuseShadingModel",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Schaar-Panchula"
}
]
},
{
"type": "DirectBeamShadingModel",
"values": [
{
"id": 0,
"name": "Linear"
},
{
"id": 1,
"name": "None"
},
{
"id": 2,
"name": "2 Dimension (retired)"
},
{
"id": 3,
"name": "Fractional Electrical Shading"
},
{
"id": 5,
"name": "Module File Defined Shading"
}
]
},
{
"type": "EnergyInputMethod",
"values": [
{
"id": 0,
"name": "Manual Input"
},
{
"id": 1,
"name": "Map Extrapolation"
},
{
"id": 2,
"name": "Model 8760"
}
]
},
{
"type": "EntityType",
"values": [
{
"id": 1,
"name": "Project"
},
{
"id": 2,
"name": "Module"
},
{
"id": 3,
"name": "Inverter"
},
{
"id": 4,
"name": "Weather"
},
{
"id": 5,
"name": "Prediction"
},
{
"id": 6,
"name": "MultiJunction"
}
]
},
{
"type": "ESSChargeAlgorithm",
"values": [
{
"id": 0,
"name": "LGIA Excess"
},
{
"id": 1,
"name": "Energy Available"
},
{
"id": 2,
"name": "Custom"
}
]
},
{
"type": "ESSDispatchCustomCommand",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Discharge"
},
{
"id": 2,
"name": "Charge"
}
]
},
{
"type": "EvalType",
"values": [
{
"id": 0,
"name": "FieldEval"
},
{
"id": 1,
"name": "GroupEval"
},
{
"id": 2,
"name": "TabRepeat"
}
]
},
{
"type": "FacialityEnum",
"values": [
{
"id": 0,
"name": "Monofacial"
},
{
"id": 1,
"name": "Bifacial"
}
]
},
{
"type": "IncidenceAngleModelType",
"values": [
{
"id": 2,
"name": "Sandia"
},
{
"id": 3,
"name": "ASHRAE"
},
{
"id": 4,
"name": "None"
},
{
"id": 5,
"name": "Tabular IAM"
}
]
},
{
"type": "InverterType",
"values": [
{
"id": 0,
"name": "Unspecified"
},
{
"id": 1,
"name": "String"
},
{
"id": 2,
"name": "Central"
}
]
},
{
"type": "JunctionType",
"values": [
{
"id": 0,
"name": "Parallel"
},
{
"id": 1,
"name": "Series"
}
]
},
{
"type": "LibraryStatusEnum",
"values": [
{
"id": 0,
"name": "Unknown"
},
{
"id": 1,
"name": "Draft-Private"
},
{
"id": 2,
"name": "Draft-Shared"
},
{
"id": 3,
"name": "Active"
},
{
"id": 4,
"name": "Retired"
},
{
"id": 5,
"name": "Global"
},
{
"id": 6,
"name": "Global-Retired"
}
]
},
{
"type": "MapBuilderCreateDCOptions",
"values": [
{
"id": 0,
"name": "Arrays"
},
{
"id": 1,
"name": "Tables"
}
]
},
{
"type": "MarionDiffuseRegions",
"values": [
{
"id": 0,
"name": "Sky"
},
{
"id": 1,
"name": "Ground"
}
]
},
{
"type": "MessageType",
"values": [
{
"id": 1,
"name": "Error"
},
{
"id": 2,
"name": "Warning"
},
{
"id": 3,
"name": "Info"
},
{
"id": 4,
"name": "Debug"
}
]
},
{
"type": "MessageTypeEnum",
"values": [
{
"id": 0,
"name": "Prediction"
},
{
"id": 1,
"name": "Report"
}
]
},
{
"type": "ModuleDegradationModel",
"values": [
{
"id": 0,
"name": "Unspecified"
},
{
"id": 1,
"name": "Linear"
},
{
"id": 2,
"name": "Non-Linear"
}
]
},
{
"type": "ModuleDurability",
"values": [
{
"id": 0,
"name": "Standard"
},
{
"id": 1,
"name": "Quality"
},
{
"id": 2,
"name": "High"
}
]
},
{
"type": "ModuleOrientation",
"values": [
{
"id": 0,
"name": "Landscape"
},
{
"id": 1,
"name": "Portrait"
}
]
},
{
"type": "ModuleShadingResponse",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Linear"
},
{
"id": 2,
"name": "Fractional Electrical Shading"
}
]
},
{
"type": "ModuleTemperatureModelType",
"values": [
{
"id": 0,
"name": "Heat Balance"
},
{
"id": 1,
"name": "Sandia"
}
]
},
{
"type": "NSRDBRegions",
"values": [
{
"id": 0,
"name": "USA"
},
{
"id": 1,
"name": "Mexico"
},
{
"id": 2,
"name": "Americas"
},
{
"id": 3,
"name": "Europe"
},
{
"id": 4,
"name": "Africa"
},
{
"id": 5,
"name": "Asia"
},
{
"id": 6,
"name": "South_Asia"
},
{
"id": 7,
"name": "Australia_Pacific"
}
]
},
{
"type": "PowerPlantDesignType",
"values": [
{
"id": 0,
"name": "Simple"
},
{
"id": 1,
"name": "Advanced"
}
]
},
{
"type": "PredictionItemStatisticsTrackingTypeEnum",
"values": [
{
"id": 0,
"name": "Fixed Tilt"
},
{
"id": 1,
"name": "Horizontal Tracker"
},
{
"id": 2,
"name": "Seasonal Tilt"
},
{
"id": 3,
"name": "Mixed"
}
]
},
{
"type": "PredictionProcessingStep",
"values": [
{
"id": 0,
"name": "Unknown"
},
{
"id": 1,
"name": "None"
},
{
"id": 2,
"name": "InitializeFromDatabase"
},
{
"id": 3,
"name": "PrePrediction"
},
{
"id": 4,
"name": "PreparePrediction"
},
{
"id": 5,
"name": "PrepareWeather"
},
{
"id": 6,
"name": "PrepareWeatherDetail"
},
{
"id": 7,
"name": "ExecuteDiffuseDecompModel"
},
{
"id": 8,
"name": "PreparePowerPlant"
},
{
"id": 9,
"name": "PrepareBlocks"
},
{
"id": 10,
"name": "PrepareArrays"
},
{
"id": 11,
"name": "PrepareInverters"
},
{
"id": 12,
"name": "PrepareDCFields"
},
{
"id": 13,
"name": "PrepareModules"
},
{
"id": 14,
"name": "InitializeResults"
},
{
"id": 15,
"name": "MainPrediction"
},
{
"id": 16,
"name": "MainOuterPredictionLoop"
},
{
"id": 17,
"name": "FormattingWeatherFileForMultiYear"
},
{
"id": 18,
"name": "DCFieldCalculationLogic"
},
{
"id": 19,
"name": "InverterCalculationLogic"
},
{
"id": 20,
"name": "ArrayCalculationLogic"
},
{
"id": 21,
"name": "BlockCalculationLogic"
},
{
"id": 22,
"name": "PowerPlantCalculationLogic"
},
{
"id": 23,
"name": "ESSCalculationLogic"
},
{
"id": 24,
"name": "StructureShadingLogic"
},
{
"id": 25,
"name": "AggregateResults"
},
{
"id": 26,
"name": "PostPrediction"
},
{
"id": 27,
"name": "CalculatePredictionParameters"
},
{
"id": 28,
"name": "CalculatePlantCharactersitics"
},
{
"id": 29,
"name": "CalculateLocationParameters"
},
{
"id": 30,
"name": "CalculateResultSummary"
},
{
"id": 31,
"name": "CalculateBlockResultSummaries"
},
{
"id": 32,
"name": "CalculateDetailedOutputs"
},
{
"id": 33,
"name": "StoreResults"
},
{
"id": 34,
"name": "HandleNodalData"
},
{
"id": 35,
"name": "ExportCSV"
},
{
"id": 36,
"name": "ExportJSON"
},
{
"id": 37,
"name": "CreatePredictionStatistics"
},
{
"id": 38,
"name": "Completed"
}
]
},
{
"type": "PredictionStatusEnum",
"values": [
{
"id": 1,
"name": "Draft-Private"
},
{
"id": 2,
"name": "Draft-Shared"
},
{
"id": 3,
"name": "Analysis"
},
{
"id": 4,
"name": "Bid"
},
{
"id": 5,
"name": "Contract"
},
{
"id": 6,
"name": "Development"
},
{
"id": 7,
"name": "As Built"
},
{
"id": 8,
"name": "Warranty"
},
{
"id": 9,
"name": "Archived"
}
]
},
{
"type": "PredictionVersionEnum",
"values": [
{
"id": 3,
"name": "Version 3"
},
{
"id": 4,
"name": "Version 4"
},
{
"id": 5,
"name": "Version 5"
},
{
"id": 6,
"name": "Version 6"
},
{
"id": 7,
"name": "Version 7"
},
{
"id": 8,
"name": "Version 8"
},
{
"id": 9,
"name": "Version 9"
},
{
"id": 10,
"name": "Version 10"
}
]
},
{
"type": "ProcessingStatusEnum",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Queued"
},
{
"id": 2,
"name": "Running"
},
{
"id": 3,
"name": "Success"
},
{
"id": 4,
"name": "Error"
},
{
"id": 5,
"name": "Cancelled"
}
]
},
{
"type": "ProjectStatusEnum",
"values": [
{
"id": 0,
"name": "Active"
},
{
"id": 1,
"name": "Archived"
},
{
"id": 2,
"name": "StringSize"
}
]
},
{
"type": "PvModelType",
"values": [
{
"id": 0,
"name": "1-Diode Recombination"
},
{
"id": 1,
"name": "1-Diode"
},
{
"id": 3,
"name": "1-Diode Recombination Non-Linear Temp"
}
]
},
{
"type": "ResponseMessageType",
"values": [
{
"id": 0,
"name": "Info"
},
{
"id": 1,
"name": "Warning"
},
{
"id": 2,
"name": "Error"
}
]
},
{
"type": "RevenueType",
"values": [
{
"id": 0,
"name": "PPA"
},
{
"id": 1,
"name": "Merchant"
}
]
},
{
"type": "ShadeAlgorithm",
"values": [
{
"id": 0,
"name": "2D(default)"
},
{
"id": 1,
"name": "Infinite Rows"
},
{
"id": 2,
"name": "3D"
}
]
},
{
"type": "SoilingModelType",
"values": [
{
"id": 0,
"name": "Constant Monthly"
},
{
"id": 1,
"name": "Weather File"
},
{
"id": 2,
"name": "None"
}
]
},
{
"type": "SolarGISVersion",
"values": [
{
"id": 0,
"name": "PVPlanner"
},
{
"id": 1,
"name": "TMY15"
},
{
"id": 2,
"name": "TMY60"
}
]
},
{
"type": "SpectralResponseEnum",
"values": [
{
"id": 0,
"name": "No Spectral Shift"
},
{
"id": 1,
"name": "FS Series 4 & Earlier"
},
{
"id": 2,
"name": "FS Series 4-2 & Later"
},
{
"id": 3,
"name": "Sandia"
}
]
},
{
"type": "SpectralShiftModel",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "1-Param Pwat or Sandia"
},
{
"id": 2,
"name": "2-Param Pwat and AM"
},
{
"id": 3,
"name": "Monthly Override"
}
]
},
{
"type": "SpectralWeatherType",
"values": [
{
"id": 0,
"name": "None"
},
{
"id": 1,
"name": "Ngan-PWat"
},
{
"id": 2,
"name": "Ngan-RH"
},
{
"id": 3,
"name": "Ngan-Dewpoint"
}
]
},
{
"type": "TableType",
"values": [
{
"id": 0,
"name": "Flat"
},
{
"id": 1,
"name": "Sloped"
}
]
},
{
"type": "TimeSeriesType",
"values": [
{
"id": 0,
"name": "InverterSetPoint"
},
{
"id": 1,
"name": "InverterDerate"
},
{
"id": 2,
"name": "TrackingAngle"
},
{
"id": 3,
"name": "ModuleSurfaceTemperature"
},
{
"id": 4,
"name": "LGIALimit"
},
{
"id": 5,
"name": "IMPPAdjustment"
},
{
"id": 6,
"name": "VMPPAdjustment"
}
]
},
{
"type": "TranspositionModelType",
"values": [
{
"id": 0,
"name": "Hay"
},
{
"id": 1,
"name": "Perez"
}
]
},
{
"type": "UserStatusEnum",
"values": [
{
"id": 0,
"name": "Disabled"
},
{
"id": 1,
"name": "Active"
},
{
"id": 2,
"name": "Pending"
},
{
"id": 3,
"name": "Archived"
}
]
},
{
"type": "WeatherDataProvider",
"values": [
{
"id": 1,
"name": "NREL"
},
{
"id": 2,
"name": "AWS Truepower"
},
{
"id": 3,
"name": "WindLogics"
},
{
"id": 4,
"name": "Meteonorm"
},
{
"id": 5,
"name": "3TIER"
},
{
"id": 6,
"name": "Clean Power Research"
},
{
"id": 7,
"name": "GeoModel Solar"
},
{
"id": 8,
"name": "GeoSUN Africa"
},
{
"id": 9,
"name": "SoDa"
},
{
"id": 10,
"name": "HelioClim"
},
{
"id": 11,
"name": "Solar Resource Assessment"
},
{
"id": 12,
"name": "EnergyPlus"
},
{
"id": 13,
"name": "Other"
},
{
"id": 14,
"name": "Customer"
},
{
"id": 15,
"name": "Solar Prospector"
},
{
"id": 16,
"name": "GlobalFED"
},
{
"id": 17,
"name": "NSRDB"
},
{
"id": 18,
"name": "WhiteBox Technologies"
},
{
"id": 19,
"name": "SolarGIS"
},
{
"id": 20,
"name": "NASA"
},
{
"id": 21,
"name": "3TIER/Vaisala"
},
{
"id": 22,
"name": "Solcast"
}
]
},
{
"type": "WeatherDataType",
"values": [
{
"id": 0,
"name": "Synthetic Monthly"
},
{
"id": 1,
"name": "Satellite"
},
{
"id": 2,
"name": "Ground Corrected"
},
{
"id": 3,
"name": "Measured"
},
{
"id": 4,
"name": "TMY3"
},
{
"id": 5,
"name": "TGY"
},
{
"id": 6,
"name": "TMY"
},
{
"id": 7,
"name": "PSM"
},
{
"id": 8,
"name": "SUNY"
},
{
"id": 9,
"name": "MTS2"
},
{
"id": 10,
"name": "CZ2010"
}
]
},
{
"type": "WeatherFileColumnTypeEnum",
"values": [
{
"id": 1,
"name": "GHI"
},
{
"id": 2,
"name": "DNI"
},
{
"id": 3,
"name": "DHI"
},
{
"id": 4,
"name": "TEMP"
},
{
"id": 5,
"name": "Windspeed"
},
{
"id": 6,
"name": "RelativeHumidity"
},
{
"id": 7,
"name": "PWAT"
},
{
"id": 8,
"name": "Rain"
},
{
"id": 9,
"name": "Pressure"
},
{
"id": 10,
"name": "DewpointTemp"
},
{
"id": 11,
"name": "WindDirection"
},
{
"id": 12,
"name": "SoilingLoss"
},
{
"id": 13,
"name": "POAI"
}
]
},
{
"type": "WeatherFormat",
"values": [
{
"id": 1,
"name": "Solar Prospector CSV"
},
{
"id": 2,
"name": "NREL TMY3"
},
{
"id": 3,
"name": "Meteonorm TMY3"
},
{
"id": 4,
"name": "3Tier"
},
{
"id": 5,
"name": "AWS"
},
{
"id": 6,
"name": "EPW"
},
{
"id": 7,
"name": "GeoModel Solar"
},
{
"id": 8,
"name": "Clean Power Research"
},
{
"id": 9,
"name": "PlantPredict"
},
{
"id": 10,
"name": "TMY3"
},
{
"id": 11,
"name": "SolarGIS"
},
{
"id": 12,
"name": "NASA"
},
{
"id": 13,
"name": "3Tier/Vaisala"
},
{
"id": 14,
"name": "Solcast"
}
]
},
{
"type": "WeatherPLevel",
"values": [
{
"id": 0,
"name": "P50"
},
{
"id": 1,
"name": "P90"
},
{
"id": 2,
"name": "N/A"
},
{
"id": 3,
"name": "P95"
},
{
"id": 4,
"name": "P99"
},
{
"id": 5,
"name": "P75"
}
]
},
{
"type": "WeatherSourceTypeAPIEnum",
"values": [
{
"id": 0,
"name": "Unknown"
},
{
"id": 1,
"name": "Meteonorm"
},
{
"id": 2,
"name": "CPR-SolarAnywhere"
},
{
"id": 3,
"name": "NSRDB PSM"
},
{
"id": 4,
"name": "NSRDB SUNY"
},
{
"id": 5,
"name": "NSRDB MTS2"
},
{
"id": 6,
"name": "SolarGIS"
},
{
"id": 7,
"name": "NASA"
},
{
"id": 8,
"name": "Solcast"
}
]
},
{
"type": "WeatherTimestampDefinitionEnum",
"values": [
{
"id": 0,
"name": "Undefined"
},
{
"id": 1,
"name": "IntervalEnd"
},
{
"id": 2,
"name": "IntervalBegin"
},
{
"id": 3,
"name": "IntervalMiddle"
}
]
}
]