Jump to

• Request
• Response

Get Scenarios

get

/scenarios

Get scenarios matching search criteria. Response includes links to all basic scenario attributes, excluding approvers, participants, comments, and scripts.

Request

Query Parameters

• application:

  Application name.

• approvalPending:

  Scenario is in submitted state, and approval is pending from logged in user.

• count:

  If true, response contains only the count of scenarios, and not actual scenarios.

• database:

  Database name.

• filter:

  Scenario name wildcard pattern.

• limit:

  Maximum number of scenarios to return. Default is 50.

• offset:

  Number of scenarios to omit from the start of the result set. Default is 0.

• orderBy:

  Order-by field and order for the result set. The value of this parameter must follow the format of fieldName:asc|desc. For example, name:asc. Default value is createdTime:desc, meaning that scenarios are listed with the most recently created scenarios first.

• overdue:

  If true, returns all scenarios past the due date. Default is false, meaning all scenarios are returned.

• role:

  Optional user role by which to filter the scenario list. Value can be owner, participant, or approver. If role is specified as approver, this API returns all scenarios for which the logged in user is the approver. By default, all scenarios are returned for which the logged in user is either an owner, a participant, or an approver.

• state:

  Scenario state.

Back to Top

Response

200 Response

OK

Scenario list and details returned successfully.

400 Response

Bad Request

Failed to get scenarios.

500 Response

Internal Server Error.

Back to Top