scenarios

Get list of all visible scenarios

Get scenarios for this app that are visible to you.

A scenario object contains the following fields:

name: The name of the scenario
owner: The owner of this scenario
tags: The tags of the scenario
last_modified: The timestamp when the scenario was last modified
read_perm: Array of users/groups that have permissions to read the scenario data (groups are indicated by a leading hash #)
write_perm: Array of users/groups that have permissions to modify the scenario data (groups are indicated by a leading hash #)
exec_perm: Array of users/groups that have permissions to execute the scenario (groups are indicated by a leading hash #)

get/scenarios/{app_id}/

Path parameters

app_idstring required

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

Query parameters

pageinteger

Pagination: The page number to return (offset)

per_pageinteger

Pagination: Number of items to return per page

Response

Successful Response

namestring required

tagsstring[] required

ownerstring required

last_modifiedstring date-time required

read_permstring[] required

write_permstring[] required

exec_permstring[] required

Changes

Changed in 8 of the 18 revisions of this API.3111

Jun 30, 2026358e5609409b1See the full diff
- ○
  api operation id get_scenario_list removed and replaced with get_scenario_list_scenarios__app_id___get
  api-operation-id-removed
Feb 24, 20262ac7baf8418f2See the full diff
- ○
  added the optional property detail/items/ctx to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property detail/items/input to the response with the 422 status
  response-optional-property-added
Jun 14, 202587a967423b012See the full diff
- ○
  added the new optional query request parameter page
  new-optional-request-parameter
- ○
  added the new optional query request parameter per_page
  new-optional-request-parameter
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 22, 20225366dfd18e831See the full diff
- ▲
  response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422
  response-property-list-of-types-widened
Dec 8, 2021dae88d8eb1ce1See 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
Dec 8, 2021ea0ae3dcf9691See 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
Nov 22, 2021f1a3e6959567114See the full diff
- ▲
  removed the required property items/lastModified from the response with the 200 status
  response-required-property-removed
- ●
  for the path request parameter app_id, the maxLength was set to 60
  request-parameter-max-length-set
- ○
  added the required property items/exec_perm to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/last_modified to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/read_perm to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/write_perm to the response with the 200 status
  response-required-property-added
Nov 19, 20218040d163caad1See the full diff
- ○
  endpoint added
  endpoint-added

Full history