Interface TargetFieldDescription

AttributeDescription variant for a field on the Fact Sheet at the other end of a relation (e.g. displayName of a linked BusinessCapability).

  • type — discriminant: 'targetField'
  • name — key used to access this value in the response node
  • field — field name on the target Fact Sheet
  • fieldType — the data model FieldType
  • relation — relation to traverse
  • activeOnly — when true, only includes target Fact Sheets in an active lifecycle phase
  • targetFactSheetType — type of the target Fact Sheet; '*' means any type is accepted
  • constrainedBy — optional list of constraining relation names that further scope the traversal
interface TargetFieldDescription {
    activeOnly: boolean;
    constrainedBy?: string[];
    field: string;
    fieldType: FieldType;
    name: string;
    relation: string;
    targetFactSheetType: string;
    type: "targetField";
}

Properties

activeOnly: boolean
constrainedBy?: string[]
field: string
fieldType: FieldType
name: string
relation: string
targetFactSheetType: string

The Fact Sheet type of the target Fact Sheet. A '*' means that any Fact Sheet type is possible.

type: "targetField"

Generated using TypeDoc