Initializing help system before first use

insightapi2~perform_upgrade

Purpose
Create an upgrade from the provided app zip file. Upgrading an app will augment all the resources in the app with the contents of the zip. This will record the progress and outcome of upgrading the app.
Synopsis
function perform_upgrade(client:insightapi2~insightconfig, req:insightapi2~httprequest, resp:insightapi2~httpresponse):insightapi2~upgrade
function perform_upgrade(client:insightapi2~insightconfig, app:insightapi2~file_data, upgrade_request:insightapi2~upgrade_request, resp:insightapi2~httpresponse):insightapi2~upgrade
function perform_upgrade(client:insightapi2~insightconfig, app:insightapi2~file_data, upgrade_request:insightapi2~upgrade_request):insightapi2~upgrade
Arguments
client 
An initialized insightapi2~insightconfig to call
req 
An initialized insightapi2~httprequest record. The params field may contain these indexes:
app 
(a insightapi2~file_data value)
upgradeRequest 
app 
A record describing the file to upload
upgrade_request 
A insightapi2~upgrade_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~upgrade
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~upgrade Upgrade created
403 Access denied
413 insightapi2~error_response The file containing the upgrade contents exceeds the maximum file upload size
422 insightapi2~error_response invalid target for the supplied upgrade file

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~upgrade), 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~file_data
insightapi2~upgrade
insightapi2~upgrade_request
insightapi2~insightconfig
insightapi2~httprequest
insightapi2~httpresponse

Parent Topic Portations 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.