Interface Solution

A solution represents a connection between an extractor and a source system it can be configured to read from.

interface Solution {
    documentation?: string;
    externalId: string;
    extractorExternalId?: string;
    name: string;
    sourceSystemExternalId: string;
    type?: ItemType;
}

Properties

documentation? externalId extractorExternalId? name sourceSystemExternalId type?

Properties

Optionaldocumentation

documentation?: string

Long-form documentation of the solution, describing how to use the referenced extractor to connect to the referenced source.

externalId

externalId: string

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

OptionalextractorExternalId

extractorExternalId?: string

External ID of the extractor of this solution.

name

name: string

Solution name.

sourceSystemExternalId

sourceSystemExternalId: string

External ID of the source system of this solution.

Optionaltype

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