Reference to a record view.

A view can be used as a record source when its usedFor is 'record' and its streamId targets the stream being read from or written to. View properties map (and may rename) container properties, and a view may embed a filter which is applied (in addition to the request filter) on every read through the view. Record views are managed with the Data Modeling views API (client.views).

interface ViewReference {
    externalId: string;
    space: string;
    type: "view";
    version: string;
}

Properties

externalId: string

External-id of the view

space: string

Id of the space that the view belongs to

type: "view"
version: string

Version of the view