ScenarioListItem

Trimmed scenario summary returned by GET /scenarios. spec carries entityKeys instead of the full per-entity data. Fetch GET /scenarios/{key} for the full data (and its ETag header) before any mutation.

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • metadata
    Type: object
    required

    Identity fields for a scenario — key plus human-facing descriptors. Same shape as ResourceIdentity but without version (scenarios have no draft/published lifecycle).

    • key
      Type: string
      required

      Scenario key (snake_case, customer-supplied; stable across updates).

    • name
      Type: string
      required

      Display name.

    • description
      Type: string

      Optional description.

    • labels
      Type: object

      Free-form labels for filtering / organization.

  • spec
    Type: object
    required
    • entityKeys
      Type: array string[]
      required

      Keys of every entity in this scenario. Fetch the scenario by key for the actual data payloads.

  • updatedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z