Interface ExternalFileInfo

interface ExternalFileInfo {
    assetIds?: number[];
    dataSetId?: number;
    directory?: string;
    externalId?: string;
    geoLocation?: FileGeoLocation;
    labels?: ExternalId[];
    metadata?: Metadata;
    mimeType?: string;
    name: string;
    securityCategories?: number[];
    source?: string;
    sourceCreatedTime?: Date;
    sourceModifiedTime?: Date;
}

Hierarchy (view full)

Properties

assetIds?: number[]

Asset-centric file metadata, 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.

dataSetId?: number

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.

directory?: string
externalId?: string
geoLocation?: FileGeoLocation
labels?: ExternalId[]

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.

metadata?: Metadata
mimeType?: string
name: string
securityCategories?: number[]

Security categories on files are deprecated 2026-10-15 and retired 2027-12-31. Use data products and granular access control 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?: Date
sourceModifiedTime?: Date