Skip to content
Eigen Documentation

getRelatedAssets

Return assets related to one or more nodes.

Signature

Section titled “Signature”

getRelatedAssets(nodes, prop="code", exact=False, relation=None, output="json")

  • nodes (str | list[str])
  • prop (str, default: “code”)
  • exact (bool, default: False)
  • relation (str | None)
  • output (str): json (default), df, raw

Inputs

Section titled “Inputs”
  • nodes: Node code(s) or property values to match.
  • prop: Node property name to match on.
  • exact: Use exact string matches instead of partial matches.
  • relation: Filter by relationship type.
  • output: Output format selector.

Examples

Section titled “Examples”
Section titled “Related assets for a single node”
related = model.getRelatedAssets("System_01")

Response (json):

[
  {
    "sourceNode": "System_01",
    "relatedAsset": { "code": "Pump_01", "name": "Pump 01" },
    "relationshipType": "feeds"
  }
]

Filter by relationship type

Section titled “Filter by relationship type”
related = model.getRelatedAssets("System_01", relation="feeds")

DataFrame output

Section titled “DataFrame output”
related_df = model.getRelatedAssets(["System_01", "System_02"], output="df")
sourceNoderelatedAssetrelationshipType
System_01Pump_01feeds
System_02Pump_02feeds