Interface SourceSystem

A source system representing a source extractors may read from.

interface SourceSystem {
    description: string;
    documentation?: string;
    externalId: string;
    imageUrl?: string;
    name: string;
    tags?: string[];
    type: ItemType;
}

Properties

description documentation? externalId imageUrl? name tags? type

Properties

description

description: string

Short description of the source system.

Optionaldocumentation

documentation?: string

Long-form description of the source system.

externalId

externalId: string

The external ID provided by the client. Must be unique for the resource type.

OptionalimageUrl

imageUrl?: string

URL of a publicly hosted logo for the source system.

name

name: string

Source system name.

Optionaltags

tags?: string[]

Tags A list of tags, used for searching and filtering.

type

type: ItemType

Status of this item. "Global" means that it is maintained by Cognite and considered official. "Community" means that it is community made and maintained. "Unreleased" means that it is not yet released and it is visible only as a preview or closed beta.

Settings

Member Visibility

On This Page

Properties