AppInterface.list_scen_attach
AppInterface.list_scen_attach |
Purpose
Retrieves a list of all the files attached to a given scenario.
Synopsis
list_scen_attach(self, scenario_path: str = None) -> List[xpressinsight.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.
Example
Example of fetching information about all attachments of a scenario into a list called
atts
>>> atts = insight.list_scen_attach()
... if insight.attach_status == AttachStatus.OK:
... print("Attachments: ", atts)
... else:
... print("Error listing attachments")
Getting the list of attachments for the current scenario
>>> atts = insight.list_scen_attach('/myapp/DirA/myscenario')
... if insight.attach_status == AttachStatus.OK:
... print("Attachments: ", atts)
... else:
... print("Error listing attachments")
Getting the list of attachments for a scenario with path
/myapp/DirA/myscenario
Further information
Check the attachment status code using
insight.attach_status to determine whether the attachments list was successfully retrieved. 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