Skip to main content

ListScenariosCustomerResponse

data object[]required

List of scenarios in the project.

  • Array [
  • idstring<uuid>required

    The ID of the scenario.

    namestringrequired

    The name of the scenario.

    description objectrequired

    The description of the scenario.

    anyOf
    string
    roundId objectrequired

    The ID of the round the scenario belongs to. Null for baseline scenarios.

    anyOf
    string<uuid>
    roundName objectrequired

    The name of the round the scenario belongs to. Null for baseline scenarios.

    anyOf
    string
    createdAtstring<date-time>required

    When the scenario was created.

    updatedAt objectrequired

    When the scenario was last updated. Null if the scenario has never been updated.

    anyOf
    string<date-time>
    isAwardedbooleanrequired

    Whether the scenario has been picked as the awarded one.

    isLastRound objectrequired

    Whether the scenario is based on the last round's bids. Null for baseline scenarios, which are round-agnostic.

    anyOf
    boolean
  • ]
  • pagination objectrequired
    nextCursor objectrequired

    A cursor used to fetch the next page of results. It is null if there is no next page. Use the value as cursor parameter to fetch the next page.

    oneOf
    string
    hasMorebooleanrequired

    Indicates whether there are more results available. Keep calling the API with the provided nextCursor until hasMore is false to retrieve all results.

    totalnumberrequired

    The total number of results available.

    Example: 42
    ListScenariosCustomerResponse
    {
    "data": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "roundId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "roundName": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "isAwarded": true,
    "isLastRound": true
    }
    ],
    "pagination": {
    "nextCursor": "MjAyNS0wMS0wMSAxNzoyOTo1OS4yNwo=",
    "hasMore": true,
    "total": 42
    }
    }