Skip to content
Renewables.Architect

Queue Analysis

POST
/analyses

Queue an analysis. Endpoint receives application definition file and generates an analysis ID.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
organization_name
Any of:
string

Header Parameters

Section titled “Header Parameters ”
x-originating-user-id
X-Originating-User-Id
string
x-originating-user-organization-name
X-Originating-User-Organization-Name
string

Request Body required

Section titled “Request Body required ”
ApplicationDefinition

A Renewables.Architect application definition dictionary. Inherits from RunDefinition which contains all the required fields for an application definition except the driver.

object
application_name
required
Application Name
string
environment
required
Environment
object
environment_type
required
Environment Type
string
environment_parameters
required
Environment Parameters
object
shared_inputs
Any of:
object
assembly
required
Assembly
object
key
additional properties
RAJSONSchemaModel
object
model_type
required
Model Type
string
inputs
required
Inputs
object
outputs
Any of:
object
packages
Any of:
Array
model_packages
Any of:
Array
environment_packages
Any of:
Array
validator_packages
Any of:
Array
driver_packages
Any of:
Array
python_version
required
Python Version
string
comments
Any of:
string
driver
Any of:
_Driver
object
driver_type
required
Driver Type
string
driver_parameters
required
Driver Parameters
object

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

AnalysisIdentifier
object
analysis_id
required
Analysis Id
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string