Sign in
scenarios

Download a scenario

Download a scenario.

get/scenarios/{app_id}/download

Path parameters

app_idstring required

The ID of the app whose data you want to operate on.

The ID of the app whose data you want to operate on.

Query parameters

namestring required

The name of the scenario you want to download.

The name of the scenario you want to download.

file_type'miroscen' | 'gdx' | 'csv' | 'xlsx'

In which file type should the scenario be exported?

ownerstring nullable

The owner of the scenario you want to download (by default, the logged in user).

The owner of the scenario you want to download (by default, the logged in user).

Response

Successful Response

{"stackTrail":"paths:/scenarios/{app_id}/download:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 9 of the 18 revisions of this API.4312

  • 358e5609409b1See the full diff
    • ○

      api operation id download_scenario removed and replaced with download_scenario_scenarios__app_id__download_get

      api-operation-id-removed

  • 42a5a480092d15See the full diff
    • ▲

      the query request parameter file_type was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value csv to the query request parameter file_type

      request-parameter-enum-value-added

    • ○

      added the new enum value gdx to the query request parameter file_type

      request-parameter-enum-value-added

    • ○

      added the new enum value miroscen to the query request parameter file_type

      request-parameter-enum-value-added

    • ○

      added the new enum value xlsx to the query request parameter file_type

      request-parameter-enum-value-added

    • ○

      for the query request parameter file_type, the type/format was generalized from / to string/

      request-parameter-type-generalized

  • 6befde16ec1c2See the full diff
    • ○

      query request parameter owner list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      for the query request parameter owner, the type/format was generalized from string/ to /

      request-parameter-type-generalized

  • 331d925238991See the full diff
    • ▲

      for the query request parameter name, the maxLength was decreased from 64 to 63

      request-parameter-max-length-decreased

  • 77bcd6c895ba1See the full diff
    • ○

      for the query request parameter name, the maxLength was increased from 63 to 64

      request-parameter-max-length-increased

  • dae88d8eb1ce1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ea0ae3dcf9691See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f1a3e6959567131See the full diff
    • ▲

      removed the media type application/json for the response with the status 422

      response-media-type-removed

    • ●

      for the path request parameter app_id, the maxLength was set to 60

      request-parameter-max-length-set

    • ●

      for the query request parameter name, the maxLength was set to 63

      request-parameter-max-length-set

    • ●

      for the query request parameter owner, the maxLength was set to 70

      request-parameter-max-length-set

    • ○

      added the new optional query request parameter file_type

      new-optional-request-parameter

  • 8040d163caad1See the full diff
    • ○

      endpoint added

      endpoint-added