Skip to content
TotalView API

Get Project Details

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

Get full project details including the complete config_snapshot.

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
ProjectDetailOut

Detailed project output with full latest run.

object
project_id
required
Project Id
string format: uuid
config
required
Config
object
key
additional properties
any
latest_run
Any of:
object
key
additional properties
any
latest_run_status
Any of:
string
latest_run_id
Any of:
string format: uuid
Example generated
{
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "config": {},
  "latest_run": {},
  "latest_run_status": "example",
  "latest_run_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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": {}
    }
  ]
}