Get Scenarios

GET /public/v1/projects/{projectId}/scenarios
Api key

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required

Query parameters

  • asOf string

Responses

  • 500 */*

    Internal Server Error
  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • id integer(int64) Required

      The unique identifier of the scenario

    • modelId integer(int64) Required

      The unique identifier of the model

    • name string Required

      The name of the scenario

    • description string Required

      The description of the scenario

    • dataDate string(date) Required

      The data date of the scenario

    • scenarioType string Required

      The type of the scenario

      Values are COMPLETE or PARTIAL.

    • activityId integer(int64) Required

      The unique identifier of the associated activity
GET /public/v1/projects/{projectId}/scenarios 
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects/{projectId}/scenarios' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500) 
{}
Response examples (200) 
[
  {
    "id": 123,
    "modelId": 456,
    "name": "Baseline Scenario",
    "description": "This is the baseline scenario for project X.",
    "dataDate": "2024-01-15",
    "scenarioType": "COMPLETE",
    "activityId": 789
  }
]