interface RelationshipsFilter {
    activeAtTime?: DateRange;
    confidence?: Range<number>;
    createdTime?: DateRange;
    dataSetIds?: IdEither[];
    endTime?: DateRange;
    labels?: LabelFilter;
    lastUpdatedTime?: DateRange;
    sourceExternalIds?: string[];
    sourceTypes?: RelationshipResourceType[];
    startTime?: DateRange;
    targetExternalIds?: string[];
    targetTypes?: RelationshipResourceType[];
}

Hierarchy (view full)

Properties

activeAtTime?: DateRange

Limits results to those active at any point within the given time range, i.e. if there is any overlap in the intervals [activeAtTime.min, activeAtTime.max] and [startTime, endTime], where both intervals are inclusive. If a relationship does not have a startTime, it is regarded as active from the beginning of time by this filter. If it does not have an endTime is will be regarded as active until the end of time. Similarly, if a min is not supplied to the filter, the min will be implicitly set to the beginning of time, and if a max is not supplied, the max will be implicitly set to the end of time.

confidence?: Range<number>

Confidence range to filter for

createdTime?: DateRange
dataSetIds?: IdEither[]

Only include relationships that reference these specific dataSet IDs

endTime?: DateRange
labels?: LabelFilter

Return only the resource matching the specified label constraints

lastUpdatedTime?: DateRange
sourceExternalIds?: string[]

Include relationships that have any of these values in their sourceExternalId field

sourceTypes?: RelationshipResourceType[]

Items Enum: "asset" "timeSeries" "file" "event" "sequence". Include relationships that have any of these values in their sourceType field

startTime?: DateRange
targetExternalIds?: string[]

Include relationships that have any of these values in their targetExternalId field

targetTypes?: RelationshipResourceType[]

Items Enum: "asset" "timeSeries" "file" "event" "sequence". Include relationships that have any of these values in their targetType field