Interface FileFilterProps

interface FileFilterProps {
    assetIds?: number[];
    assetSubtreeIds?: IdEither[];
    createdTime?: DateRange;
    dataSetIds?: IdEither[];
    directoryPrefix?: string;
    externalIdPrefix?: string;
    geoLocation?: FileGeoLocationFilter;
    labels?: LabelFilter;
    lastUpdatedTime?: DateRange;
    metadata?: Metadata;
    mimeType?: string;
    name?: string;
    rootAssetIds?: IdEither[];
    source?: string;
    sourceCreatedTime?: DateRange;
    sourceModifiedTime?: DateRange;
    uploaded?: boolean;
    uploadedTime?: DateRange;
}

Properties

assetIds?: number[]

Only include files that reference these specific asset IDs.

Asset filters on files are deprecated 2026-10-15 and retired 2027-12-31. Query CogniteFile instances connected to CogniteAsset instead. Will be removed in a future major release. See https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md#files-asset-centric-metadata-and-filters.

assetSubtreeIds?: IdEither[]

Only include files that are related to an asset in a subtree rooted at any of these assetIds. If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.

Asset filters on files are deprecated 2026-10-15 and retired 2027-12-31. Query CogniteFile instances connected to CogniteAsset instead. Will be removed in a future major release. See https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md#files-asset-centric-metadata-and-filters.

createdTime?: DateRange
dataSetIds?: IdEither[]

Only include items that reference these specific dataSet IDs

Data sets on files are deprecated 2026-10-15 and retired 2027-12-31. Scope data with spaces and govern consumption with data products instead. Will be removed in a future major release. See https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md#files-asset-centric-metadata-and-filters.

directoryPrefix?: string
externalIdPrefix?: string
geoLocation?: FileGeoLocationFilter
labels?: LabelFilter

Return only the resource matching the specified label constraints.

Labels on files are deprecated 2026-10-15 and retired 2027-12-31. There is no direct replacement; model labels as a concept in your data model. Will be removed in a future major release. See https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md#files-asset-centric-metadata-and-filters.

lastUpdatedTime?: DateRange
metadata?: Metadata
mimeType?: string
name?: string
rootAssetIds?: IdEither[]

Only include files that have a related asset in a tree rooted at any of these root assetIds.

Asset filters on files are deprecated 2026-10-15 and retired 2027-12-31. Query CogniteFile instances connected to CogniteAsset instead. Will be removed in a future major release. See https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md#files-asset-centric-metadata-and-filters.

source?: string
sourceCreatedTime?: DateRange
sourceModifiedTime?: DateRange
uploaded?: boolean
uploadedTime?: DateRange