Examples
Create a New Scenario
This example will create a new scenario of the default scenario type in the root of the app with the provided ID:
https://<INSIGHTURL>/api/scenarios
{
"name": "Scenario Five",
"parent": {
"id": "00007eff-83f9-05fe-ffff-81007c05fc01",
"objectType": "APP"
},
"scenarioType": "FAST_SCENARIO"
}| Value | Required | Description | |
|---|---|---|---|
| name | Yes | Designated name for the new scenario | |
| parent | Yes | Destination app or folder for the new scenario | |
| id | Parent folder or app id | ||
| objectType | Parent folder or app objectType | ||
| scenarioType | No | Optional value - If provided, the type must be specified by the scenario's app. Value defaults to SCENARIO if not provided |
|
Request Responses
| Value | Status | Description |
|---|---|---|
| 201 | Scenario was successfully created. | The response body contains a description of the scenario which is equivalent to that returned by a GET request to the response body's url property. |
| 4xx | Request has been rejected and the scenario will not have been created. |
Possible reasons include
|
| 5xx | Server or network error. The scenario may or may not have been created. | Call the GET /api/apps/{id}/children or /api/folders/{id}/children endpoint to find out whether scenario was created. |
Clone an Existing Scenario
{
"name": "Scenario Six",
"parent": {
"id": "01f7774e-00c2-004e-fe08-88b1834def44",
"objectType": "FOLDER"
},
"sourceScenario": {
"id": "003584bb-9e7b-eb70-ffca-7b446118b100",
"name": "My scenario",
"objectType": "SCENARIO"
}
}| Value | Required | Description | |
|---|---|---|---|
| name | Yes | Designated Name for the cloned Scenario | |
| parent | Yes | Destination App or Folder for the new Scenario | |
| id | Parent folder or app id | ||
| name | Parent folder or app name | ||
| objectType | Parent folder or app objectType | ||
| sourceScenario | No | Optional - If provided, the type must be specified by the scenario's app Value defaults to SCENARIO if not provided | |
| id | |||
| name | |||
| objectType | |||
Request Responses
| Value | Status | Description |
|---|---|---|
| 201 | Scenario was successfully cloned. | The response body contains a description of the scenario which is equivalent to that returned by a GET request to the response body's url property. |
| 4xx | Request has been rejected and the scenario will not have been cloned. |
Possible reasons include
|
| 5xx | Server or network error. The scenario may or may not have been cloned. | Call the GET /api/apps/{id}/children or /api/folders/{id}/children endpoint to find out whether scenario was cloned. |
Load Scenario Data
This example will request that the scenario with the specified ID is queued for execution with the LOAD execution mode:
https://<INSIGHTURL>/api/jobs
{
"executionMode": "LOAD",
"scenario": {
"id": "003584bb-9e7b-eb70-ffca-7b446118b100"
}
}
| Value | Required | Description | |
|---|---|---|---|
| executionMode | Yes | Required to load the data | |
| scenario | Yes | The target scenario | |
| id | |||
Request Responses
| Value | Status | Description |
|---|---|---|
| 201 | The load job was successfully created. | The response body contains a description of the job which is equivalent to that returned by a GET request to the response body's url property. |
| 4xx | Request has been rejected and the scenario data will not have been loaded. |
Possible reasons include
|
| 5xx | Server or network error. The job may or may not have been created. | Call the GET /api/jobs endpoint to find out whether job was created. |
Read an Entity Value
This example will get the values of the entities alpha and beta (without any filters):
https://<INSIGHTURL>/api/scenarios/{id}/data
{
"entityNames": [ "alpha", "beta" ],
"filters": []
}| Value | Required | Description |
|---|---|---|
| entityNames | Yes | Entity values to return |
| filters | No | Filters to be applied |
Delete a Scenario
This example will request the deletion of the scenario with the specified scenario ID:
https://<INSIGHTURL>/api/scenarios/{id}
Request Responses
| Value | Status | Description |
|---|---|---|
| 204 | The scenario was successfully deleted. | |
| 4xx | Request has been rejected. |
Possible reasons include
|
© 2001-2024 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.