Projects

Check the progress and outcome of a PVFARM import

Poll this with the ID returned by POST /Project/{projectId}/Prediction/{predictionId}/Import/PVFarm. Checking once every 10 seconds is plenty; a large file can take a few minutes.

status is Processing while the import is running, then Completed or Failed. On Completed, plant carries the headline figures of the built power plant and equipment lists the library records created from the file’s datasheet values. On Failed, errorCode distinguishes a problem with the file, a problem with the target prediction, and a problem on the PlantPredict side.

plant and equipment are empty until the import finishes, so read status first.

An import is visible only to the account that created it.

Parameters:

jobId (path, required): The import job ID returned by the import request.

GET

Project

Import

PVFarm

{jobId}

Check the progress and outcome of a PVFARM import

curl --request GET \
  --url https://api.plantpredict.terabase.energy/Project/Import/PVFarm/{jobId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.plantpredict.terabase.energy/Project/Import/PVFarm/{jobId}"

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/Project/Import/PVFarm/{jobId}', 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/Project/Import/PVFarm/{jobId}",
  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/Project/Import/PVFarm/{jobId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.plantpredict.terabase.energy/Project/Import/PVFarm/{jobId}")

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

{
  "jobId": 316,
  "status": "Completed",
  "originalFileName": "Desert Ridge.pvfshade",
  "projectId": 192183,
  "predictionId": 965830,
  "summary": "Imported a 122.20 MW DC power plant (182,381 modules, 2,379 trackers, 28 inverters) onto prediction 965830 and built its 3D shade scene.",
  "errorCode": null,
  "error": null,
  "plant": {
    "mwDc": 122.1953,
    "modules": 182381,
    "strings": 6289,
    "trackers": 2379,
    "inverters": 28
  },
  "equipment": [
    {
      "kind": "module",
      "id": 47413,
      "name": "PVFARM California PV Module 670W"
    },
    {
      "kind": "inverter",
      "id": 10560,
      "name": "PVFARM Generic Inverter 3600kW"
    }
  ],
  "notices": []
}

"Project not found."

"An error has occurred."

Authorizations

Authorization

string

header

required

Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.

Path Parameters

jobId

integer<int64>

required

Response

The current state of the import job

The state and outcome of a PVFARM import job.

jobId

integer<int64>

required

status

enum<string>

required

Processing — still running, check again shortly. Completed — finished; the power plant and its 3D shade scene are on the prediction. Failed — nothing was built; errorCode says why.

Available options:

Processing,

Completed,

Failed

originalFileName

string | null

The uploaded filename.

projectId

integer<int64>

The project containing the target prediction.

predictionId

integer<int64>

The prediction the plant was built on.

summary

string | null

One sentence describing the outcome in plain language, suitable to relay to a person as-is.

errorCode

string | null

Set only when status is Failed. One of:

invalid-file — the file could not be used: not a PVFARM shading model file, an old format version, a fixed-tilt project, or a module technology PlantPredict does not recognize. Re-export from PVFARM, or use the web application's import.
prediction-not-eligible — the target prediction cannot take the import: no weather file selected, not a Block Builder prediction, or it already has a built power plant and the call did not carry overwriteExistingPowerPlant=true.
import-error — a fault on the PlantPredict side. Contact support with the jobId; retrying the same file will not help.

error

string | null

Free-form detail accompanying errorCode.

plant

object | null

Headline figures for the built plant. Null until the import completes successfully.

Show child attributes

equipment

object[] | null

The library records created from the file's datasheet values — one Module per module type and one Inverter per inverter type. Re-importing the same data reuses these records rather than creating duplicates, and says so in notices.

Show child attributes

notices

string[] | null

Informational messages about the import, such as equipment records reused rather than created.

⌘I

Check the progress and outcome of a PVFARM import

curl --request GET \
  --url https://api.plantpredict.terabase.energy/Project/Import/PVFarm/{jobId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.plantpredict.terabase.energy/Project/Import/PVFarm/{jobId}"

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/Project/Import/PVFarm/{jobId}', 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/Project/Import/PVFarm/{jobId}",
  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/Project/Import/PVFarm/{jobId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.plantpredict.terabase.energy/Project/Import/PVFarm/{jobId}")

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

{
  "jobId": 316,
  "status": "Completed",
  "originalFileName": "Desert Ridge.pvfshade",
  "projectId": 192183,
  "predictionId": 965830,
  "summary": "Imported a 122.20 MW DC power plant (182,381 modules, 2,379 trackers, 28 inverters) onto prediction 965830 and built its 3D shade scene.",
  "errorCode": null,
  "error": null,
  "plant": {
    "mwDc": 122.1953,
    "modules": 182381,
    "strings": 6289,
    "trackers": 2379,
    "inverters": 28
  },
  "equipment": [
    {
      "kind": "module",
      "id": 47413,
      "name": "PVFARM California PV Module 670W"
    },
    {
      "kind": "inverter",
      "id": 10560,
      "name": "PVFARM Generic Inverter 3600kW"
    }
  ],
  "notices": []
}

"Project not found."

"An error has occurred."

Introduction

Quick Start Guides

API Reference

API Tools

SDK Documentation

Check the progress and outcome of a PVFARM import

Authorizations

Path Parameters

Response