Initializing help system before first use

xpressinsight.scenario.InsightRestClient.create_scenario

Purpose
Create a new scenario within an app.
Synopsis
xpressinsight.scenario.InsightRestClient.create_scenario(self, name: str, parent: scenario.Reference, scenario_type: Optional[str] = None) -> scenario.Scenario
Arguments
name 
The name for the scenario. A suffix will be applied to ensure the name is unique among its siblings.
parent 
A Reference of type FOLDER containing the ID of the folder in which to create the scenario, or a reference of type APP containing the app ID if the scenario is to be created in the app root folder.
scenario_type 
The type of the scenario to create, as defined by the app. If none is specified, default to SCENARIO.
Return value

Information about the newly-created scenario.

This function may raise the following errors:

  scenario.InsightServerError

If the scenario could not be created in the requested location, the REST client credentials do not have permission to perform this operation, or there is an issue communicating with the Insight server.

Example 
>>> with ins.InsightRestClient(insight_url='http://localhost:8080/') as client:
...     FOLDER_ID = '570b9100-46e3-4643-baee-2e24aa538f25'
...     scenario = client.create_scenario(name='My Scenario',
...         parent=ins.Reference.to_folder(FOLDER_ID))
...     print(f'Created scenario {scenario.name} with ID {scenario.id}')
Further information
The method create_scenario is part of the class xpressinsight.scenario.InsightRestClient.
Related topics
scenario.InsightRestClient.clone_scenario,
scenario.Reference,
scenario.Scenario

Parent Topic The InsightRestClient classes

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.