Skip to main content

Get Scenario

Get data of a scenario.

info

Available in Contextal Platform 1.0 and later.

Request

  • Path: /api/v1/scenarios/{id}
  • Verb: GET
  • Path parameters:
    • id: the id of the scenario to retrieve

Reply

On success:

  • Status: 200 - OK
  • Content-Type: application/json
  • Body: a Scenario object

On failure:

  • Status:
    • 404 if the scenario id is not found
    • 4xx or 5xx