Interface DocumentSourceFile

The source file that this document is derived from.

interface DocumentSourceFile {
    assetIds?: number[];
    datasetId?: number;
    directory?: string;
    geoLocation?: DocumentGeoJsonGeometry;
    hash?: string;
    labels?: LabelList;
    metadata?: Record<string, string>;
    mimeType?: string;
    name: string;
    securityCategories?: number[];
    size?: number;
    source?: string;
}

Properties

assetIds? datasetId? directory? geoLocation? hash? labels? metadata? mimeType? name securityCategories? size? source?

Properties

OptionalassetIds

assetIds?: number[]

The ids of the assets related to this file

Example

[]

OptionaldatasetId

datasetId?: number

The id if the dataset this file belongs to, if any

Optionaldirectory

directory?: string

The directory the file can be found in

Example

plays/shakespeare

OptionalgeoLocation

geoLocation?: DocumentGeoJsonGeometry

GeoJSON Geometry.

Optionalhash

hash?: string

The hash of the source file. This is a SHA256 hash of the original file. The hash only covers the file content, and not other CDF metadata.

Example

23203f9264161714cdb8d2f474b9b641e6a735f8cea4098c40a3cab8743bd749

Optionallabels

labels?: LabelList

A list of labels associated with this document's source file in CDF.

Optionalmetadata

metadata?: Record<string, string>

OptionalmimeType

mimeType?: string

The mime type of the file

Example

application/octet-stream

name

name: string

Name of the file.

Example

hamlet.txt

OptionalsecurityCategories

securityCategories?: number[]

The security category IDs required to access this file

Example

[]

Optionalsize

size?: number

The size of the source file in bytes

Format

int64

Example

1000

Optionalsource

source?: string

The source of the file

Example

SubsurfaceConnectors

Settings

Member Visibility

On This Page

Properties