Skip to content
Eigen Documentation

getDocuments

Return documents related to an asset.

Signature

Section titled “Signature”

getDocuments(node, document_type="all", output="json", filepath=None)

  • node (str)
  • document_type (str, default: “all”)
  • output (str): json (default), df, raw, file
  • filepath (str | None)

Inputs

Section titled “Inputs”
  • node: Asset code to fetch documents for.
  • document_type: all, merged, or a specific type name.
  • output: Output format selector.
  • filepath: Output file path used when output="file".

Examples

Section titled “Examples”

All documents

Section titled “All documents”
documents = menu.getDocuments("System_01", document_type="all")

Merged documents

Section titled “Merged documents”
documents = menu.getDocuments("System_01", document_type="merged")

Specific document type

Section titled “Specific document type”
documents = menu.getDocuments("System_01", document_type="P&ID")

DataFrame output

Section titled “DataFrame output”
documents_df = menu.getDocuments("System_01", document_type="merged", output="df")