Skip to content
TotalView API

List Scenarios

GET
/api/v1/projects/{project_id}/scenarios
 
curl --request GET \
  --url https://api.totalview.energy/api/v1/projects/example/scenarios \
  --header 'Authorization: Bearer <token>'

List all scenarios for a project.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
project_id
required
Project Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
ScenarioListOut

Response schema for listing scenarios.

object
scenarios
required
Scenarios
Array<object>
ScenarioOut

Response schema for a scenario.

object
scenario_id
required
Scenario Id
string format: uuid
project_id
required
Project Id
string format: uuid
scenario_name
required
Scenario Name
string
description
Any of:
string
config_snapshot
Config Snapshot
object
key
additional properties
any
is_default
Is Default
boolean
scenario_version
Scenario Version
integer
default: 1
latest_run_status
Any of:
string
latest_run_id
Any of:
string format: uuid
created_at
Any of:
string format: date-time
updated_at
Any of:
string format: date-time
nameplate_capacity
Any of:
number
poi_limit
Any of:
number
tech_type_id
Any of:
string
battery_flag
Any of:
boolean
ppa_flag
Any of:
boolean
Example 
{
  "scenarios": [
    {
      "is_default": false,
      "scenario_version": 1
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}