Class CogniteClient

SDK client (beta)

For smooth transition between stable sdk and beta, you may create an alias "@cognite/sdk": "@cognite/sdk-beta@^<version>" in package.json The beta SDK exports the client with the same name as stable, meaning you don't need to change any imports.

import { CogniteClient } from '@cognite/sdk';

const client = new CogniteClient({ appId: 'YOUR APPLICATION NAME' });

// can also specify a base URL
const client = new CogniteClient({ ..., baseUrl: 'https://greenfield.cognitedata.com' });

Param: options

Client options

Hierarchy (view full)

CogniteClientCleaned
- CogniteClient

Constructors

constructor

new CogniteClient(options, apiVersion?): CogniteClient

Create a new SDK client

Parameters

options: ClientOptions

Client options

import { CogniteClient } from '@cognite/sdk';

const client = new CogniteClient({ appId: 'YOUR APPLICATION NAME' });

// can also specify a base URL
const client = new CogniteClient({ ..., baseUrl: 'https://greenfield.cognitedata.com' });

apiVersion: "v1" = 'v1'

Returns CogniteClient

Properties

authenticate

authenticate: (() => Promise<undefined | string>) = ...

`Readonly`project

project: string

Accessors

alerts

get alerts(): AlertsAPI
Returns AlertsAPI
- Defined in packages/beta/src/cogniteClient.ts:35

annotations

get annotations(): AnnotationsAPI
Returns AnnotationsAPI
Inherited from CogniteClientCleaned.annotations
- Defined in packages/stable/src/cogniteClient.ts:119

assetMappings3D

get assetMappings3D(): AssetMappings3DAPI
Returns AssetMappings3DAPI
Inherited from CogniteClientCleaned.assetMappings3D
- Defined in packages/stable/src/cogniteClient.ts:101

assets

get assets(): AssetsAPI
Returns AssetsAPI
Inherited from CogniteClientCleaned.assets
- Defined in packages/stable/src/cogniteClient.ts:53

containers

get containers(): ContainersAPI
Returns ContainersAPI
Inherited from CogniteClientCleaned.containers
- Defined in packages/stable/src/cogniteClient.ts:182

dataModels

get dataModels(): DataModelsAPI
Returns DataModelsAPI
Inherited from CogniteClientCleaned.dataModels
- Defined in packages/stable/src/cogniteClient.ts:191

datapoints

get datapoints(): DataPointsAPI
Returns DataPointsAPI
Overrides CogniteClientCleaned.datapoints
- Defined in packages/beta/src/cogniteClient.ts:46

datasets

get datasets(): DataSetsAPI
Returns DataSetsAPI
Inherited from CogniteClientCleaned.datasets
- Defined in packages/stable/src/cogniteClient.ts:98

documents

get documents(): DocumentsAPI
Returns DocumentsAPI
Inherited from CogniteClientCleaned.documents
- Defined in packages/stable/src/cogniteClient.ts:116

entityMatching

get entityMatching(): EntityMatchingApi
Returns EntityMatchingApi
Inherited from CogniteClientCleaned.entityMatching
- Defined in packages/stable/src/cogniteClient.ts:110

events

get events(): EventsAPI
Returns EventsAPI
Inherited from CogniteClientCleaned.events
- Defined in packages/stable/src/cogniteClient.ts:65

files

get files(): FilesAPI
Returns FilesAPI
Overrides CogniteClientCleaned.files
- Defined in packages/beta/src/cogniteClient.ts:38

files3D

get files3D(): Files3DAPI
Returns Files3DAPI
Inherited from CogniteClientCleaned.files3D
- Defined in packages/stable/src/cogniteClient.ts:95

functions

get functions(): FunctionsAPI
Returns FunctionsAPI
Inherited from CogniteClientCleaned.functions
- Defined in packages/stable/src/cogniteClient.ts:71

geospatial

get geospatial(): GeospatialAPI
Returns GeospatialAPI
Inherited from CogniteClientCleaned.geospatial
- Defined in packages/stable/src/cogniteClient.ts:113

groups

get groups(): GroupsAPI
Returns GroupsAPI
Inherited from CogniteClientCleaned.groups
- Defined in packages/stable/src/cogniteClient.ts:83

instances

get instances(): InstancesAPI
Returns InstancesAPI
Inherited from CogniteClientCleaned.instances
- Defined in packages/stable/src/cogniteClient.ts:179

labels

get labels(): LabelsAPI
Returns LabelsAPI
Inherited from CogniteClientCleaned.labels
- Defined in packages/stable/src/cogniteClient.ts:74

models3D

get models3D(): Models3DAPI
Returns Models3DAPI
Inherited from CogniteClientCleaned.models3D
- Defined in packages/stable/src/cogniteClient.ts:89

monitoringTasks

get monitoringTasks(): MonitoringTasksAPI
Returns MonitoringTasksAPI
- Defined in packages/beta/src/cogniteClient.ts:42

profiles

get profiles(): ProfilesAPI
Returns ProfilesAPI
Inherited from CogniteClientCleaned.profiles
- Defined in packages/stable/src/cogniteClient.ts:131

projects

get projects(): ProjectsAPI
Returns ProjectsAPI
Inherited from CogniteClientCleaned.projects
- Defined in packages/stable/src/cogniteClient.ts:80

raw

get raw(): RawAPI
Returns RawAPI
Inherited from CogniteClientCleaned.raw
- Defined in packages/stable/src/cogniteClient.ts:77

records

get records(): RecordsAPI
Returns RecordsAPI
Inherited from CogniteClientCleaned.records
- Defined in packages/stable/src/cogniteClient.ts:197

relationships

get relationships(): RelationshipsApi
Returns RelationshipsApi
Inherited from CogniteClientCleaned.relationships
- Defined in packages/stable/src/cogniteClient.ts:107

revisions3D

get revisions3D(): Revisions3DAPI
Returns Revisions3DAPI
Inherited from CogniteClientCleaned.revisions3D
- Defined in packages/stable/src/cogniteClient.ts:92

securityCategories

get securityCategories(): SecurityCategoriesAPI
Returns SecurityCategoriesAPI
Inherited from CogniteClientCleaned.securityCategories
- Defined in packages/stable/src/cogniteClient.ts:86

sequences

get sequences(): SequencesAPI
Returns SequencesAPI
Inherited from CogniteClientCleaned.sequences
- Defined in packages/stable/src/cogniteClient.ts:62

sessions

get sessions(): SessionsApi
Returns SessionsApi
Inherited from CogniteClientCleaned.sessions
- Defined in packages/stable/src/cogniteClient.ts:134

spaces

get spaces(): SpacesAPI
Returns SpacesAPI
Inherited from CogniteClientCleaned.spaces
- Defined in packages/stable/src/cogniteClient.ts:188

streams

get streams(): StreamsAPI
Returns StreamsAPI
Inherited from CogniteClientCleaned.streams
- Defined in packages/stable/src/cogniteClient.ts:194

templates

get templates(): {
    group: ((externalId: string) => {
        version: ((version: number) => {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        });
        versions: TemplateGroupVersionsApi;
    });
    groups: TemplateGroupsApi;
}
Returns {
    group: ((externalId: string) => {
        version: ((version: number) => {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        });
        versions: TemplateGroupVersionsApi;
    });
    groups: TemplateGroupsApi;
}
- group: ((externalId: string) => {
      version: ((version: number) => {
          instances: TemplateInstancesApi;
          runQuery: (<TVariables>(graphQlParams: {
              operationName?: string;
              query: string;
              variables?: TVariables;
          }) => Promise<GraphQlResponse>);
          views: ViewsApi;
      });
      versions: TemplateGroupVersionsApi;
  })
  - - (externalId): {
          version: ((version: number) => {
              instances: TemplateInstancesApi;
              runQuery: (<TVariables>(graphQlParams: {
                  operationName?: string;
                  query: string;
                  variables?: TVariables;
              }) => Promise<GraphQlResponse>);
              views: ViewsApi;
          });
          versions: TemplateGroupVersionsApi;
      }
    - Parameters
      externalId: string
      Returns {
          version: ((version: number) => {
              instances: TemplateInstancesApi;
              runQuery: (<TVariables>(graphQlParams: {
                  operationName?: string;
                  query: string;
                  variables?: TVariables;
              }) => Promise<GraphQlResponse>);
              views: ViewsApi;
          });
          versions: TemplateGroupVersionsApi;
      }
      - version: ((version: number) => {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        })
        (version): {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        }
        Parameters
        version: number
        Returns {
            instances: TemplateInstancesApi;
            runQuery: (<TVariables>(graphQlParams: {
                operationName?: string;
                query: string;
                variables?: TVariables;
            }) => Promise<GraphQlResponse>);
            views: ViewsApi;
        }
        instances: TemplateInstancesApi
        runQuery: (<TVariables>(graphQlParams: {
            operationName?: string;
            query: string;
            variables?: TVariables;
        }) => Promise<GraphQlResponse>)
        <TVariables>(graphQlParams): Promise<GraphQlResponse>
        Type Parameters
        TVariables extends Record<string, unknown>
        Parameters
        graphQlParams: {
            operationName?: string;
            query: string;
            variables?: TVariables;
        }
        OptionaloperationName?: string
        query: string
        Optionalvariables?: TVariables
        Returns Promise<GraphQlResponse>
        views: ViewsApi
      - versions: TemplateGroupVersionsApi
- groups: TemplateGroupsApi
Inherited from CogniteClientCleaned.templates
- Defined in packages/stable/src/cogniteClient.ts:137

timeseries

get timeseries(): TimeSeriesAPI
Returns TimeSeriesAPI
Inherited from CogniteClientCleaned.timeseries
- Defined in packages/stable/src/cogniteClient.ts:56

units

get units(): UnitsAPI
Returns UnitsAPI
Inherited from CogniteClientCleaned.units
- Defined in packages/stable/src/cogniteClient.ts:176

viewer3D

get viewer3D(): Viewer3DAPI
Returns Viewer3DAPI
Inherited from CogniteClientCleaned.viewer3D
- Defined in packages/stable/src/cogniteClient.ts:104

views

get views(): ViewsAPI
Returns ViewsAPI
Inherited from CogniteClientCleaned.views
- Defined in packages/stable/src/cogniteClient.ts:185

vision

get vision(): VisionAPI
Returns VisionAPI
Deprecated
Retirement date: 2027-02-17. See https://docs.cognite.com/cdf/deprecated#deprecated-and-retired-features for more details.
Inherited from CogniteClientCleaned.vision
- Defined in packages/stable/src/cogniteClient.ts:125

Methods

delete

delete<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for DELETE
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const response = await client.delete('someUrl');
```
Returns Promise<HttpResponse<T>>
Inherited from CogniteClientCleaned.delete
- Defined in packages/core/src/baseCogniteClient.ts:310

get

get<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for GET
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const response = await client.get('/api/v1/projects/{project}/assets', { params: { limit: 50 }});
```
Returns Promise<HttpResponse<T>>
Inherited from CogniteClientCleaned.get
- Defined in packages/core/src/baseCogniteClient.ts:265

getBaseUrl

getBaseUrl(): string
Returns the base-url used for all requests.

Returns string
Inherited from CogniteClientCleaned.getBaseUrl
- Defined in packages/core/src/baseCogniteClient.ts:225

getDefaultRequestHeaders

getDefaultRequestHeaders(): HttpHeaders
Returns the default HTTP request headers, including e.g. authentication headers that is included in all requests. Headers provided per-requests is not included in this list. This function is useful when constructing API requests outside the SDK.
```
const customUrl = '...';
const headers = client.getDefaultRequestHeaders();
const result = await fetch(customUrl, { headers });
```
Returns HttpHeaders
Inherited from CogniteClientCleaned.getDefaultRequestHeaders
- Defined in packages/core/src/baseCogniteClient.ts:241

getMetadata

getMetadata(value): undefined | Metadata
Lookup response metadata from an request using the response as the parameter
```
const createdAsset = await client.assets.create([{ name: 'My first asset' }]);
const metadata = client.getMetadata(createdAsset);
```
Parameters
- value: object
Returns undefined | Metadata
Inherited from CogniteClientCleaned.getMetadata
- Defined in packages/core/src/baseCogniteClient.ts:253

patch

patch<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for PATCH
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const response = await client.patch('someUrl');
```
Returns Promise<HttpResponse<T>>
Inherited from CogniteClientCleaned.patch
- Defined in packages/core/src/baseCogniteClient.ts:324

post

post<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for POST
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const assets = [{ name: 'First asset' }, { name: 'Second asset' }];
const response = await client.post('/api/v1/projects/{project}/assets', { data: { items: assets } });
```
Returns Promise<HttpResponse<T>>
Inherited from CogniteClientCleaned.post
- Defined in packages/core/src/baseCogniteClient.ts:296

put

put<T>(path, options?): Promise<HttpResponse<T>>
Basic HTTP method for PUT
Type Parameters
- T = unknown
Parameters
- path: string
  The URL path
- Optionaloptions: RetryableHttpRequestOptions
  Request options, optional
```
const response = await client.put('someUrl');
```
Returns Promise<HttpResponse<T>>
Inherited from CogniteClientCleaned.put
- Defined in packages/core/src/baseCogniteClient.ts:280

`Static`urlEncodeExternalId

urlEncodeExternalId(externalId): string
Parameters
- externalId: string
Returns string
Inherited from CogniteClientCleaned.urlEncodeExternalId
- Defined in packages/stable/src/cogniteClient.ts:295

Class CogniteClient

Param: options

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CogniteClient

Properties

authenticate

Readonlyproject

Accessors

alerts

Returns AlertsAPI

annotations

Returns AnnotationsAPI

assetMappings3D

Returns AssetMappings3DAPI

assets

Returns AssetsAPI

containers

Returns ContainersAPI

dataModels

Returns DataModelsAPI

datapoints

Returns DataPointsAPI

datasets

Returns DataSetsAPI

documents

Returns DocumentsAPI

entityMatching

Returns EntityMatchingApi

events

Returns EventsAPI

files

Returns FilesAPI

files3D

Returns Files3DAPI

functions

Returns FunctionsAPI

geospatial

Returns GeospatialAPI

groups

Returns GroupsAPI

instances

Returns InstancesAPI

labels

Returns LabelsAPI

models3D

Returns Models3DAPI

monitoringTasks

Returns MonitoringTasksAPI

profiles

Returns ProfilesAPI

projects

Returns ProjectsAPI

raw

Returns RawAPI

records

Returns RecordsAPI

relationships

Returns RelationshipsApi

revisions3D

Returns Revisions3DAPI

securityCategories

Returns SecurityCategoriesAPI

sequences

Returns SequencesAPI

sessions

Returns SessionsApi

spaces

Returns SpacesAPI

streams

Returns StreamsAPI

templates

group: ((externalId: string) => { version: ((version: number) => { instances: TemplateInstancesApi; runQuery: (<TVariables>(graphQlParams: { operationName?: string; query: string; variables?: TVariables; }) => Promise<GraphQlResponse>); views: ViewsApi; }); versions: TemplateGroupVersionsApi; })

`Readonly`project

group: ((externalId: string) => {
version: ((version: number) => {
instances: TemplateInstancesApi;
runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>);
views: ViewsApi;
});
versions: TemplateGroupVersionsApi;
})

Returns {
version: ((version: number) => {
instances: TemplateInstancesApi;
runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>);
views: ViewsApi;
});
versions: TemplateGroupVersionsApi;
}

version: ((version: number) => {
instances: TemplateInstancesApi;
runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>);
views: ViewsApi;
})

Returns {
instances: TemplateInstancesApi;
runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>);
views: ViewsApi;
}

runQuery: (<TVariables>(graphQlParams: {
operationName?: string;
query: string;
variables?: TVariables;
}) => Promise<GraphQlResponse>)

`Optional`operationName?: string

`Optional`variables?: TVariables

`Static`urlEncodeExternalId