Initializing help system before first use

xpressinsight.AppInterface.list_scen_attach

Purpose
Retrieves a list of all the files attached to a given scenario.
Synopsis
xpressinsight.AppInterface.list_scen_attach(self, scenario_path: str = None) -> List[Attachment]
Argument
scenario_path 
The path of a scenario. A scenario path is the full path to a scenario name starting from the repository root and including the app name. E.g. /myapp/DirA/myscenario If the scenario path is not specified, the attachment is retrieved for the current scenario
Return value

A list of the scenario attachments.

This function may raise the following errors:

  AttachError

If there is some error listing the attachments.

Example
Example of fetching information about all attachments of a scenario into a list called atts 
>>> atts = insight.list_scen_attach()
Getting the list of attachments for the current scenario 
>>> atts = insight.list_scen_attach('/myapp/DirA/myscenario')
Getting the list of attachments for a scenario with path /myapp/DirA/myscenario
Further information
1. The method list_scen_attach is part of the class xpressinsight.AppInterface.
2. To maintain backwards compatibility, attachment operations will only raise exceptions on error if the raise_attach_exceptions attribute of either the AppConfig or AppInterface class is set to True. When this is not the case, after every call to this method you should check the value of insight.attach_status to see if your request succeeded.
3. Attempting to access attachments outside an Xpress Insight scenario will access local files that have been supplied to this class.
Related topics
AppInterface.attach_status,
AppInterface.get_scen_attach,
AppInterface.list_scen_attach_by_tag,
Attachment

Parent Topic App Interface Classes

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