Initializing help system before first use

xpressinsight.AppInterface.list_scen_attach_by_tag

xpressinsight.AppInterface.list_scen_attach_by_tag


Purpose
Retrieves a list of all the files attached to a scenario with the given tag.
Synopsis
list_scen_attach_by_tag(self, tag: str, scenario_path: str = None) -> List[xpressinsight.Attachment]
Arguments
tag 
The tag to search for
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.
Example
Example of fetching information about all attachments on a scenario with the tag tag1 into a list called atts
>>> atts = insight.list_scen_attach_by_tag('mytag1')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachments: ", atts)
... else:
...     print("Error listing attachments")		
Getting the list of attachments for the current scenario with the given tag.
>>> atts = insight.list_scen_attach_by_tag('mytag1',
...                                        '/myapp/DirA/myscenario')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachments: ", atts)
... else:
...     print("Error listing attachments")		
Getting the list of attachments with the given tag for a scenario with path /myapp/DirA/myscenario.
Further information
1. Check the attachment status code using insight.attach_status to determine whether the attachments list was successfully retrieved.
2. Attempting to access attachments when the model is not being run through Xpress Insight will cause the model to abort with an error.
Related topics