insightapi2~update_scenario
Purpose
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.
Synopsis
function update_scenario(client:insightapi2~insightconfig, req:insightapi2~httprequest, resp:insightapi2~httpresponse):insightapi2~scenario
function update_scenario(client:insightapi2~insightconfig, id:text, body:insightapi2~scenario, resp:insightapi2~httpresponse):insightapi2~scenario
function update_scenario(client:insightapi2~insightconfig, id:text, body:insightapi2~scenario):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. The
params field may contain these indexes:
|
||
|
id
|
The scenario ID
|
||
|
body
|
A
insightapi2~scenario 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 |
|---|---|---|
| 200 | insightapi2~scenario | The scenario was successfully updated |
| 403 | The user did not have authorization to update this scenario | |
| 404 | insightapi2~error_response | The scenario did not exist or was unavailable to the current user |
| 422 | insightapi2~error_response | Validation of the requested changes failed. e.g. the name was too long. |
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~insightconfig
insightapi2~httprequest
insightapi2~httpresponse
insightapi2~scenario
insightapi2~insightconfig
insightapi2~httprequest
insightapi2~httpresponse
© 2001-2023 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.