Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseCogniteClient

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 BaseCogniteClient

Properties

Readonly project

project: string

Accessors

login

logout

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
  • 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: any

    Returns undefined | Metadata

patch

post

  • Basic HTTP method for POST

    Type parameters

    • T

    Parameters

    • path: string

      The URL path

    • Optional options: HttpRequestOptions

      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>>

put