Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CogniteClient

Hierarchy

Index

Constructors

constructor

  • 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' });
    • Default value apiVersion: CogniteAPIVersion = "v1"

    Returns CogniteClient

Properties

Readonly project

project: string

Accessors

annotations

apiKeys

assetMappings3D

assets

datapoints

datasets

documents

entityMatching

events

files

files3D

geospatial

groups

labels

login

logout

models3D

projects

raw

relationships

revisions3D

securityCategories

sequences

serviceAccounts

templates

timeseries

viewer3D

Methods

authenticate

  • authenticate(): Promise<undefined | string>

authenticateCredentials

  • authenticateCredentials(): Promise<undefined | string>

delete

get

getBaseUrl

  • getBaseUrl(): string

getDefaultRequestHeaders

  • 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

getMetadata

  • getMetadata(value: any): undefined | Metadata

patch

post

put

Static urlEncodeExternalId

  • urlEncodeExternalId(externalId: string): string