Projects

Check the progress and outcome of a PVsyst import

Poll this with the ID returned by POST /Project/Import/PVsyst. Checking once every 10 seconds is plenty; a large export can take several minutes.

status is Processing while the import is running, then Completed or Failed. On Completed, projectId is the created project and imported lists the variants that became predictions. skipped lists variants that were left out, each naming the file references that could not be used, so an incomplete export can be corrected and sent again. On Failed, errorCode distinguishes a problem with the ZIP from a problem on the PlantPredict side.

A partial import — some variants imported, others skipped — is a normal Completed outcome, not an error. If no variant could be imported the job is Failed and no project is created.

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

Parameters:

jobId (path, required): The import job ID returned by POST /Project/Import/PVsyst.

GET

Project

Import

PVsyst

{jobId}

Check the progress and outcome of a PVsyst import

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

import requests

url = "https://api.plantpredict.terabase.energy/Project/Import/PVsyst/{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/PVsyst/{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/PVsyst/{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/PVsyst/{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))

}

HttpResponse<String> response = Unirest.get("https://api.plantpredict.terabase.energy/Project/Import/PVsyst/{jobId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.plantpredict.terabase.energy/Project/Import/PVsyst/{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": 4471,
  "status": "Completed",
  "originalFileName": "Desert Ridge.zip",
  "projectId": 88213,
  "projectName": "Desert Ridge",
  "summary": "Imported 7 of 9 variants. 2 skipped because files they reference are missing from the ZIP or could not be read.",
  "errorCode": null,
  "error": null,
  "imported": [
    {
      "variantFile": "Desert Ridge.VC0",
      "predictionId": 90112
    }
  ],
  "skipped": [
    {
      "variantFile": "Desert Ridge.VC3",
      "reason": "References CS7N-695TB-AG.PAN, which could not be used.",
      "blockedBy": [
        {
          "category": "module",
          "fileName": "CS7N-695TB-AG.PAN",
          "problem": "Not included in the ZIP."
        }
      ]
    }
  ],
  "failed": []
}

"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 PVsyst import job.

jobId

integer<int64>

required

status

enum<string>

required

Processing — still running, check again shortly. Completed — finished; projectId is the new project. Failed — no project was created; errorCode says why.

Available options:

Processing,

Completed,

Failed

originalFileName

string | null

The uploaded ZIP filename.

projectId

integer<int64> | null

The created project. Null until the import completes successfully.

projectName

string | null

summary

string | null

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

errorCode

string | null

Set only when status is Failed. One of:

no-importable-variants — not one variant could be imported; skipped lists every file that needs fixing. Correct the export and send it again.
invalid-zip — the upload could not be read as a PVsyst export, or contained no variants. Correct the export and send it again.
import-error — a fault on the PlantPredict side. Contact support with the jobId; retrying the same ZIP will not help.

error

string | null

Free-form detail accompanying errorCode.

imported

object[] | null

Variants that became predictions. Empty until the import finishes.

Show child attributes

skipped

object[] | null

Variants left out because a file they reference could not be used. Everything that could be imported still was.

Show child attributes

failed

object[] | null

Variants that errored during creation.

Show child attributes

Get a project by IDRetrieves a single project by its ID. The user must have access to the project within their company context. **Parameters:** - `id` (path, required): The unique identifier of the project.

⌘I

Check the progress and outcome of a PVsyst import

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

import requests

url = "https://api.plantpredict.terabase.energy/Project/Import/PVsyst/{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/PVsyst/{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/PVsyst/{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/PVsyst/{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))

}

HttpResponse<String> response = Unirest.get("https://api.plantpredict.terabase.energy/Project/Import/PVsyst/{jobId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.plantpredict.terabase.energy/Project/Import/PVsyst/{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": 4471,
  "status": "Completed",
  "originalFileName": "Desert Ridge.zip",
  "projectId": 88213,
  "projectName": "Desert Ridge",
  "summary": "Imported 7 of 9 variants. 2 skipped because files they reference are missing from the ZIP or could not be read.",
  "errorCode": null,
  "error": null,
  "imported": [
    {
      "variantFile": "Desert Ridge.VC0",
      "predictionId": 90112
    }
  ],
  "skipped": [
    {
      "variantFile": "Desert Ridge.VC3",
      "reason": "References CS7N-695TB-AG.PAN, which could not be used.",
      "blockedBy": [
        {
          "category": "module",
          "fileName": "CS7N-695TB-AG.PAN",
          "problem": "Not included in the ZIP."
        }
      ]
    }
  ],
  "failed": []
}

"Project not found."

"An error has occurred."

Introduction

Quick Start Guides

API Reference

API Tools

SDK Documentation

Check the progress and outcome of a PVsyst import

Authorizations

Path Parameters

Response