An external-id reference to an existing CDF resource type item, such as a time series.

An example could be that for an existing time series stored in the CDF time series resource type with the external-id 21PT0293, then the value would be set to "21PT029", and the type would be set to "timeseries". There are no referential integrity guarantees for this, and the client should handle if the time series has been removed or the client may not have access to it.

Currently, time series, sequence and file references are supported.

interface CDFExternalIdReference {
    list?: boolean;
    maxListSize?: number;
    type: "file" | "timeseries" | "sequence";
}

Properties

list?: boolean

Specifies that the data type is a list of values. The ordering of values is preserved.

maxListSize?: number

Specifies the maximum number of values in the list

type: "file" | "timeseries" | "sequence"