Initializing help system before first use

# Scenarios Operations

insightapi2~any_scenarios_modified_since | Discover whether the scenarios under the given root in the folder structure have been modified since the provided timestamp.
insightapi2~create_scenario | 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.
insightapi2~delete_scenario | Delete a scenario including its data, attachments and run log. If a job exists for the scenario it will also be deleted.
insightapi2~get_scenario | Get a scenario by ID. A user can only see a scenario that they have read-access to.
insightapi2~get_scenario_data | Get the entity data from this scenario as described by the supplied query object.
insightapi2~get_scenario_job_metrics | Get the job metrics generated for the last execution of this scenario.
insightapi2~get_scenario_run_log | The run log is generated by the job during execution and captured against the scenario when execution completes.
insightapi2~modify_scenario_data | Modify the scenario data. The data is modified by supplying a list of entity deltas. These entity deltas contain only the elements that are added, removed or changed. The scenario data cannot be modified if the scenario is in the job queue. Security: SCENARIO_EDIT is required to modify the scenario data and the user must have write access to the scenario.
insightapi2~update_scenario | The payload contains the updates to apply to the scenario. They are all optional. The name attribute specifies the new preferred name for the scenario; a suffix will be applied to ensure its name is unique among its siblings. The share status and owner attributes control visibility of the scenario. When the share status is set to PRIVATE and no owner is supplied then the current user becomes the owner to ensure they do not lose access to the scenario. The scenario ID attribute is optional, but if it is supplied then it must match the ID in the URL. The objectType is optional, but if it is supplied then it must be SCENARIO. All other attributes are ignored. Security: SCENARIO_EDIT is required to change the folder name, SCENARIO_SHARE is required to change the share status, and SCENARIO_OWNER is required to change the owner, and the user must have write access to the scenario.

Covered Topics

- insightapi2~any_scenarios_modified_since
- insightapi2~create_scenario
- insightapi2~delete_scenario
- insightapi2~get_scenario
- insightapi2~get_scenario_data
- insightapi2~get_scenario_job_metrics
- insightapi2~get_scenario_run_log
- insightapi2~modify_scenario_data
- insightapi2~update_scenario

Parent Topic Insight REST API client

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