Interface RelationshipWithLabel

interface RelationshipWithLabel {
    allowedRedactedFieldGroups?: string[];
    cardinality?: RelationshipCardinality;
    cascadeType?: CascadeType;
    color?: string;
    conditions?: ConditionDTO[];
    createdAt?: Date;
    createdAtTimeFieldName?: string;
    createdBy?: string;
    createFlagHistoryColumnName?: string;
    dashType?: string;
    dataStoreAssignedTimeZone?: string;
    dataStoreDefaultSchemaName?: string;
    dataStoreName?: string;
    deleteFlagHistoryColumnName?: string;
    deleteTableName?: string;
    description?: string;
    displayTextFields?: SortableNameReference[];
    etag?: string;
    fields?: RelationshipFieldDTO[];
    fromObjectLabel?: string;
    fromObjectName?: string;
    heterogeneousLink?: boolean;
    historyEnabled?: boolean;
    historyManaged?: boolean;
    historyTableName?: string;
    id?: number;
    joinConditions?: BooleanExpressionUnion[];
    joinKeyFieldName?: string;
    joinTableName?: string;
    label?: string;
    lastModifiedHeaderDate?: Date;
    lastUpdatedAt?: Date;
    lastUpdatedAtTimeFieldName?: string;
    lastUpdatedBy?: string;
    lastUpdatedByUserIdFieldName?: string;
    linkFields?: {
        [index: string]: string;
    }[];
    localizedDescriptions?: LocalizedDescriptionDTO[];
    localizedLabels?: LocalizedLabelDTO[];
    localizedReverseLabels?: LocalizedLabelDTO[];
    managed?: boolean;
    name?: string;
    naturalKey?: string;
    previousCardinality?: RelationshipCardinality;
    qualifiedName?: string;
    readOnly?: boolean;
    reindexRequired?: boolean;
    relationshipLabel?: string;
    required?: boolean;
    reverseLabel?: string;
    reverseName?: string;
    solutionLabel?: string;
    solutionName?: string;
    sortCriteria?: SortCriteria;
    styles?: LinkStyleDTO[];
    summaryFields?: SortableNameReference[];
    symmetric?: boolean;
    systemReserved?: boolean;
    tableName?: string;
    tableType?: string;
    toObjectLabel?: string;
    toObjectName?: string;
    toObjectTypeFieldName?: string;
    toObjectTypeNames?: string[];
    type?: RelationshipType;
    updateFlagHistoryColumnName?: string;
    useCustomIndex?: boolean;
    validFromFieldName?: string;
    validToFieldName?: string;
    version?: number;
    versionNumberFieldName?: string;
    width?: number;
}

Hierarchy

  • RelationshipDTO
    • RelationshipWithLabel

Properties

allowedRedactedFieldGroups? cardinality? cascadeType? color? conditions? createdAt? createdAtTimeFieldName? createdBy? createFlagHistoryColumnName? dashType? dataStoreAssignedTimeZone? dataStoreDefaultSchemaName? dataStoreName? deleteFlagHistoryColumnName? deleteTableName? description? displayTextFields? etag? fields? fromObjectLabel? fromObjectName? heterogeneousLink? historyEnabled? historyManaged? historyTableName? id? joinConditions? joinKeyFieldName? joinTableName? label? lastModifiedHeaderDate? lastUpdatedAt? lastUpdatedAtTimeFieldName? lastUpdatedBy? lastUpdatedByUserIdFieldName? linkFields? localizedDescriptions? localizedLabels? localizedReverseLabels? managed? name? naturalKey? previousCardinality? qualifiedName? readOnly? reindexRequired? relationshipLabel? required? reverseLabel? reverseName? solutionLabel? solutionName? sortCriteria? styles? summaryFields? symmetric? systemReserved? tableName? tableType? toObjectLabel? toObjectName? toObjectTypeFieldName? toObjectTypeNames? type? updateFlagHistoryColumnName? useCustomIndex? validFromFieldName? validToFieldName? version? versionNumberFieldName? width?

Properties

OptionalallowedRedactedFieldGroups

allowedRedactedFieldGroups?: string[]

Optionalcardinality

cardinality?: RelationshipCardinality

OptionalcascadeType

cascadeType?: CascadeType

Optionalcolor

color?: string

Optionalconditions

conditions?: ConditionDTO[]

OptionalcreatedAt

createdAt?: Date

OptionalcreatedAtTimeFieldName

createdAtTimeFieldName?: string

OptionalcreatedBy

createdBy?: string

OptionalcreateFlagHistoryColumnName

createFlagHistoryColumnName?: string

OptionaldashType

dashType?: string

OptionaldataStoreAssignedTimeZone

dataStoreAssignedTimeZone?: string

OptionaldataStoreDefaultSchemaName

dataStoreDefaultSchemaName?: string

OptionaldataStoreName

dataStoreName?: string

OptionaldeleteFlagHistoryColumnName

deleteFlagHistoryColumnName?: string

OptionaldeleteTableName

deleteTableName?: string

Optionaldescription

description?: string

OptionaldisplayTextFields

displayTextFields?: SortableNameReference[]

Optionaletag

etag?: string

Optionalfields

fields?: RelationshipFieldDTO[]

OptionalfromObjectLabel

fromObjectLabel?: string

OptionalfromObjectName

fromObjectName?: string

OptionalheterogeneousLink

heterogeneousLink?: boolean

OptionalhistoryEnabled

historyEnabled?: boolean

OptionalhistoryManaged

historyManaged?: boolean

OptionalhistoryTableName

historyTableName?: string

Optionalid

id?: number

OptionaljoinConditions

joinConditions?: BooleanExpressionUnion[]

OptionaljoinKeyFieldName

joinKeyFieldName?: string

OptionaljoinTableName

joinTableName?: string

Optionallabel

label?: string

OptionallastModifiedHeaderDate

lastModifiedHeaderDate?: Date

OptionallastUpdatedAt

lastUpdatedAt?: Date

OptionallastUpdatedAtTimeFieldName

lastUpdatedAtTimeFieldName?: string

OptionallastUpdatedBy

lastUpdatedBy?: string

OptionallastUpdatedByUserIdFieldName

lastUpdatedByUserIdFieldName?: string

OptionallinkFields

linkFields?: {
    [index: string]: string;
}[]

OptionallocalizedDescriptions

localizedDescriptions?: LocalizedDescriptionDTO[]

OptionallocalizedLabels

localizedLabels?: LocalizedLabelDTO[]

OptionallocalizedReverseLabels

localizedReverseLabels?: LocalizedLabelDTO[]

Optionalmanaged

managed?: boolean

Optionalname

name?: string

OptionalnaturalKey

naturalKey?: string

OptionalpreviousCardinality

previousCardinality?: RelationshipCardinality

OptionalqualifiedName

qualifiedName?: string

OptionalreadOnly

readOnly?: boolean

OptionalreindexRequired

reindexRequired?: boolean

OptionalrelationshipLabel

relationshipLabel?: string

Optionalrequired

required?: boolean

OptionalreverseLabel

reverseLabel?: string

OptionalreverseName

reverseName?: string

OptionalsolutionLabel

solutionLabel?: string

OptionalsolutionName

solutionName?: string

OptionalsortCriteria

sortCriteria?: SortCriteria

Optionalstyles

styles?: LinkStyleDTO[]

OptionalsummaryFields

summaryFields?: SortableNameReference[]

Optionalsymmetric

symmetric?: boolean

OptionalsystemReserved

systemReserved?: boolean

OptionaltableName

tableName?: string

OptionaltableType

tableType?: string

OptionaltoObjectLabel

toObjectLabel?: string

OptionaltoObjectName

toObjectName?: string

OptionaltoObjectTypeFieldName

toObjectTypeFieldName?: string

OptionaltoObjectTypeNames

toObjectTypeNames?: string[]

Optionaltype

type?: RelationshipType

OptionalupdateFlagHistoryColumnName

updateFlagHistoryColumnName?: string

OptionaluseCustomIndex

useCustomIndex?: boolean

OptionalvalidFromFieldName

validFromFieldName?: string

OptionalvalidToFieldName

validToFieldName?: string

Optionalversion

version?: number

OptionalversionNumberFieldName

versionNumberFieldName?: string

Optionalwidth

width?: number

Settings

Member Visibility

On This Page

Properties
allowedRedactedFieldGroupscardinalitycascadeTypecolorconditionscreatedAtcreatedAtTimeFieldNamecreatedBycreateFlagHistoryColumnNamedashTypedataStoreAssignedTimeZonedataStoreDefaultSchemaNamedataStoreNamedeleteFlagHistoryColumnNamedeleteTableNamedescriptiondisplayTextFieldsetagfieldsfromObjectLabelfromObjectNameheterogeneousLinkhistoryEnabledhistoryManagedhistoryTableNameidjoinConditionsjoinKeyFieldNamejoinTableNamelabellastModifiedHeaderDatelastUpdatedAtlastUpdatedAtTimeFieldNamelastUpdatedBylastUpdatedByUserIdFieldNamelinkFieldslocalizedDescriptionslocalizedLabelslocalizedReverseLabelsmanagednamenaturalKeypreviousCardinalityqualifiedNamereadOnlyreindexRequiredrelationshipLabelrequiredreverseLabelreverseNamesolutionLabelsolutionNamesortCriteriastylessummaryFieldssymmetricsystemReservedtableNametableTypetoObjectLabeltoObjectNametoObjectTypeFieldNametoObjectTypeNamestypeupdateFlagHistoryColumnNameuseCustomIndexvalidFromFieldNamevalidToFieldNameversionversionNumberFieldNamewidth