Skip to content
Cloud APIs
/
/
/
VirtualScenarioCollection

VirtualScenarioCollection

A page of virtual scenarios that match the query.

itemsArray of objects(VirtualScenario)required
Example:
[
  {
    "id": "01JY70N8TE9DG79NTQZDFMGEW3",
    "name": "",
    "inputDataSource": { … },
    "state": "Ready",
    "tags": [ … ],
    "lastUpdatedAt": "2025-06-20T15:52:32.000Z"
  },
  {
    "id": "01JY70N8TE64GJ0CZE6M900M99",
    "name": "Price sensitivity - Low case",
    "inputDataSource": { … },
    "state": "Running",
    "tags": [ … ],
    "realizationFilters": { … },
    "lastUpdatedAt": "2025-06-20T15:55:18.000Z"
  },
  {
    "id": "01JY70N8TE7C2K9F4ZB1RM5QPA",
    "name": "Price sensitivity - Base case",
    "inputDataSource": { … },
    "resultDataSource": { … },
    "state": "CompletedSuccessfully",
    "tags": [ … ],
    "realizationFilters": { … },
    "lastUpdatedAt": "2025-06-20T15:57:24.000Z"
  },
  {
    "id": "01JY70N8TE8H3D0YJ6P2WQ4XYZ",
    "name": "Price sensitivity - High case",
    "inputDataSource": { … },
    "state": "CompletedWithErrors",
    "tags": [ … ],
    "realizationFilters": { … },
    "errorMessages": [ … ],
    "lastUpdatedAt": "2025-06-20T15:58:12.000Z"
  }
]
quotainteger or null, (int32)

The maximum number of virtual scenarios allowed per study.

Example:10000
totalinteger or null, (int32)

The total number of virtual scenarios matching the filters provided.

Example:6
{
  "total": 4,
  "items": [
    { … },
    { … },
    { … },
    { … }
  ]
}