Initializing help system before first use

insightapi2~create_scenario

Purpose
The payload specifies the attributes of the new scenario. The name attribute specifies the preferred name for the scenario; a suffix will be applied to ensure its name is unique among its siblings. The scenarioType attribute specifies the type of scenario to create; the app defines the available scenario types. If no scenarioType is supplied it defaults to SCENARIO. The parent attribute specifies the folder or app the scenario will be created within. It must be an app or a folder and must declare its objectType and ID. To clone a scenario specify a sourceScenario. When cloning, the new scenario will have the same scenario type as the source and any supplied scenarioType will be ignored. The scenario will be cloned into the same location as the source scenario if the parent attribute is omitted. Security: SCENARIO_NEW is required to create a new scenario and the user must have permission to modify the contents of the parent folder or app. When cloning, the user must also have permission to read the source scenario.
Synopsis
function create_scenario(client:insightapi2~insightconfig, req:insightapi2~httprequest, resp:insightapi2~httpresponse):insightapi2~scenario
function create_scenario(client:insightapi2~insightconfig, body:insightapi2~scenario_creation_request, resp:insightapi2~httpresponse):insightapi2~scenario
function create_scenario(client:insightapi2~insightconfig, body:insightapi2~scenario_creation_request):insightapi2~scenario
Arguments
client 
An initialized insightapi2~insightconfig to call
req 
An initialized insightapi2~httprequest record. The body field may be populated with a value of type insightapi2~scenario_creation_request. The params field should be empty.
body 
A insightapi2~scenario_creation_request value
resp 
A insightapi2~httpresponse record into which will be written a description of the response
Return value
The response body of the request, if it was of type insightapi2~scenario
Further information
1. Use the status field of the resp record to distinguish between different status codes returned by the operation, or the success attribute to check for 2xx status codes. If the resp record is not passed to this function, the model will abort with a runtime error if the response's status code does not indicate success. The expected responses from this operation are:
HTTP Status Code Response body type Description
201 insightapi2~scenario The scenario was successfully created
403 The user did not have authorization to create this scenario
422 insightapi2~error_response The app, parent folder or source scenario were unavailable to the current user

2. If the response body could be read into a Mosel variable, it would be written to the body field of the resp record (and also returned from this function if it was a insightapi2~scenario), and the bodyfilename field of the resp record will be an empty string.
3. If the bodyfilename field of the resp record is set to a non-empty value on return, this will be a file containing the response body; the caller is responsible for deleting this file when it is no longer required.
Related topics
insightapi2~error_response
insightapi2~scenario
insightapi2~scenario_creation_request
insightapi2~insightconfig
insightapi2~httprequest
insightapi2~httpresponse

Parent Topic Scenarios Operations

© 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.