AppInterface.get_attachs_by_tag
AppInterface.get_attachs_by_tag |
Purpose
Gets Insight attachments by tag
Synopsis
get_attachs_by_tag(self, tag: str) -> Union[List[xpressinsight.Attachment], NoneType]
Argument
|
tag
|
The tag to search for
|
Return value
A list which will be populated with the details of the attachments that were retrieved.
Example
Example of searching for and retrieving all attachments with the tag
tag1
>>> attachments = insight.get_attachs_by_tag('mytag1')
... if insight.attach_status != AttachStatus.OK:
... print("Error searching for attachments")
... else:
... for a in attachments:
... print(a.filename)
Further information
1. Check the attachment status code using
insight.attach_status to determine whether the attachment(s) were 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
AppInterface.attach_status,
AppInterface.list_scen_attach,
AppInterface.list_app_attach,
AppInterface.get_app_attach,
AppInterface.get_scen_attach