Initializing help system before first use

xpressinsight.scenario.InsightRestClient.set_scenario_attachment_info

Purpose
Updates the filename, description, tags or 'hidden' flag for the given scenario attachment.
Synopsis
xpressinsight.scenario.InsightRestClient.set_scenario_attachment_info(self, scenario_id: str, attachment_id: str, updated_info: Union[Attachment, AttachmentUpdate]) -> None
Arguments
scenario_id 
The ID of the scenario on which the attachment resides.
attachment_id 
The ID of the attachment.
updated_info 
The attachment info to update. Only the fields you want to change should be populated.
Return value

This function may raise the following errors:

  scenario.ItemNotFoundError

If the scenario 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.put_scenario_attachment(
...         scenario_id='570b9100-46e3-4643-baee-2e24aa538f25',
...         attachment_id='ae91efb6-387c-442d-b27d-655fe42a9ad4',
...         updated_info=ins.AttachmentUpdate(tags=['monthly', 'approved']))
Related topics
scenario.Attachment,
scenario.AttachmentUpdate

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.