Type alias AttributeDescription

Discriminated union describing which Fact Sheet attribute to include in a lx.getAllFactSheets() response. Choose the variant based on where the data lives:

  • 'field' (FieldDescription) — a direct scalar/object field on the Fact Sheet (e.g. businessCriticality, lifecycle)
  • 'relationField' (RelationFieldDescription) — a field that lives on the relation edge itself (e.g. technicalSuitability on relApplicationToITComponent)
  • 'targetField' (TargetFieldDescription) — a field on the Fact Sheet at the other end of a relation (e.g. displayName of a linked BusinessCapability)

The name property of each descriptor becomes the key in the response node under which the value is accessible (see ReportPointOfViewFactSheetNode).

Generated using TypeDoc