Skip to content

getDocuments

Return documents related to one or more assets.

getDocuments(nodes, match=None, output="json")

  • nodes (str | list[str])
  • match (str | None)
  • output (str): json (default), df, raw
  • nodes: Node code(s) to fetch documents for.
  • match: Filter by filename, description, or code.
  • output: Output format selector.
documents = model.getDocuments("System_01")

Response (json):

{
"System_01": [{ "fileName": "manual.pdf", "description": "System manual" }]
}
filtered = model.getDocuments("System_01", match="manual")
documents_df = model.getDocuments(["System_01", "System_02"], output="df")
codefileNamedescription
System_01manual.pdfSystem manual
System_02spec.pdfSpecs