Initializing help system before first use

insightapi2~upload_app_attachment

Purpose
Create a new app attachment or overwrite an existing one.
Synopsis
function upload_app_attachment(client:insightapi2~insightconfig, req:insightapi2~httprequest, resp:insightapi2~httpresponse):insightapi2~attachment
function upload_app_attachment(client:insightapi2~insightconfig, id:text, attachment:insightapi2~file_data, overwrite:boolean, tag_name:text, resp:insightapi2~httpresponse):insightapi2~attachment
function upload_app_attachment(client:insightapi2~insightconfig, id:text, attachment:insightapi2~file_data, overwrite:boolean, tag_name:text):insightapi2~attachment
function upload_app_attachment(client:insightapi2~insightconfig, id:text, attachment:insightapi2~file_data, hidden:boolean, overwrite:boolean, tag_name:text, resp:insightapi2~httpresponse):insightapi2~attachment
function upload_app_attachment(client:insightapi2~insightconfig, id:text, attachment:insightapi2~file_data, hidden:boolean, overwrite:boolean, tag_name:text):insightapi2~attachment
Arguments
client 
An initialized insightapi2~insightconfig to call
req 
An initialized insightapi2~httprequest record. The params field may contain these indexes:
id 
The app ID
attachment 
(a insightapi2~file_data value)
hidden 
overwrite 
tagName 
id 
The app ID
attachment 
A record describing the file to upload
hidden 
A boolean value
overwrite 
A boolean value
tag_name 
A text 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~attachment
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~attachment The uploaded attachment, with the existing ID if it was overwritten
403 The user did not have authority to add the attachment
404 insightapi2~error_response The app did not exist or was unavailable to the current user
409 insightapi2~error_response The attachment was already in the process of being updated
413 insightapi2~error_response The uploaded file was too large
422 insightapi2~error_response The filename was not permitted, or the the maximum number of files or file size was exceeded

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

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