Initializing help system before first use

xpressinsight.scenario.InsightRestClient.get_app_attachment

Purpose
Download the indicated app attachment.
Synopsis
xpressinsight.scenario.InsightRestClient.get_app_attachment(self, app_id: str, attachment_id: str, destination: Union[str, TextIO, BinaryIO], encoding: Optional[str] = 'utf-8') -> None
Arguments
app_id 
The ID of the app on which the attachment resides.
attachment_id 
The ID of the attachment.
destination 
Where to save the attachment content. This may be the name of a local file, or any file-like object.
encoding 
The character encoding to use when destination is of type TextIO. Defaults to utf-8.
Return value

This function may raise the following errors:

  scenario.ItemNotFoundError

If the app or attachment does not exist, or the REST API client credentials do not have permission to access it.

  scenario.InsightServerError

If there is an issue communicating with the Insight server.

Example 
>>> with ins.InsightRestClient(insight_url='http://localhost:8080/') as client:
...     client.get_app_attachment(
...         app_id='570b9100-46e3-4643-baee-2e24aa538f25',
...         attachment_id='ae91efb6-387c-442d-b27d-655fe42a9ad4',
...         destination='my_local_file.json')

Parent Topic The InsightRestClient classes

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