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.
Authorizations
Response
The current state of the import job
The state and outcome of a PVFARM import job.
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, 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 carryoverwriteExistingPowerPlant=true.import-error— a fault on the PlantPredict side. Contact support with thejobId; retrying the same file will not help.