Interface RelationFieldDescription

AttributeDescription variant for a field that lives on a relation edge (e.g. technicalSuitability on relApplicationToITComponent).

  • type — discriminant: 'relationField'
  • name — key used to access this value in the response node
  • field — field name on the relation edge (e.g. 'technicalSuitability')
  • fieldType — the data model FieldType
  • relation — relation name (e.g. 'relApplicationToITComponent')
  • targetFactSheetType — Fact Sheet type on the target end of the relation
  • activeOnly — when true, only includes edges whose target Fact Sheet is in an active lifecycle phase
interface RelationFieldDescription {
    activeOnly: boolean;
    field: string;
    fieldType: FieldType;
    name: string;
    relation: string;
    targetFactSheetType: string;
    type: "relationField";
}

Properties

activeOnly: boolean
field: string
fieldType: FieldType
name: string
relation: string
targetFactSheetType: string
type: "relationField"

Generated using TypeDoc