Options
All
  • Public
  • Public/Protected
  • All
Menu

Cognite JavaScript SDK

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Acl3D

AclAction3D

AclAction3D: READ | CREATE | UPDATE | DELETE

AclActionAnalytics

AclActionAnalytics: READ | EXECUTE | LIST

AclActionApiKeys

AclActionApiKeys: LIST | CREATE | DELETE

AclActionAssets

AclActionAssets: LIST | WRITE

AclActionEvents

AclActionEvents: READ | WRITE

AclActionFiles

AclActionFiles: READ | WRITE

AclActionGroups

AclActionGroups: LIST | READ | CREATE | UPDATE | DELETE

AclActionProjects

AclActionProjects: LIST | READ | CREATE | UPDATE

AclActionRaw

AclActionRaw: READ | WRITE | LIST

AclActionSecurityCategories

AclActionSecurityCategories: MEMBEROF | LIST | CREATE | DELETE

AclActionSequences

AclActionSequences: READ | WRITE

AclActionTimeseries

AclActionTimeseries: READ | WRITE

AclActionUsers

AclActionUsers: LIST | CREATE | DELETE

AclAnalytics

AclApiKeys

AclAssets

AclEvents

AclFiles

AclGroups

AclProjects

AclRaw

AclScope3D

AclScope3D: AclScopeAll

AclScopeAnalytics

AclScopeAnalytics: AclScopeAll

AclScopeApiKeys

AclScopeApiKeys: AclScopeAll | AclScopeCurrentUser

AclScopeAssets

AclScopeAssets: AclScopeAll

AclScopeEvents

AclScopeEvents: AclScopeAll

AclScopeFiles

AclScopeFiles: AclScopeAll

AclScopeGroups

AclScopeProjects

AclScopeProjects: AclScopeAll

AclScopeRaw

AclScopeRaw: AclScopeAll

AclScopeSecurityCategories

AclScopeSecurityCategories: AclScopeAll

AclScopeSequences

AclScopeSequences: AclScopeAll

AclScopeTimeseries

AclScopeTimeseries: AclScopeAll | AclScopeAssetsId

AclScopeUsers

AclScopeUsers: AclScopeAll

AclSecurityCategories

AclSequences

AclTimeseries

AclUsers

Aggregate

Aggregate: "average" | "max" | "min" | "count" | "sum" | "interpolation" | "stepInterpolation" | "totalVariation" | "continuousVariance" | "discreteVariance"

ApiKeysCreateEndpoint

ApiKeysCreateEndpoint: function

Type declaration

ApiKeysDeleteEndpoint

ApiKeysDeleteEndpoint: function

Type declaration

ApiKeysListEndpoint

ApiKeysListEndpoint: function

Type declaration

ArrayPatchLong

ArrayPatchLong: object | object

AssetChange

AssetCreateEndpoint

AssetCreateEndpoint: function

Type declaration

AssetDeleteEndpoint

AssetDeleteEndpoint: function

Type declaration

AssetDescription

AssetDescription: string

Description of asset.

AssetExternalId

AssetExternalId: ExternalId

AssetIdEither

AssetIdEither: IdEither

AssetInternalId

AssetInternalId: InternalId

AssetListEndpoint

AssetListEndpoint: function

Type declaration

AssetMappings3DCreateEndpoint

AssetMappings3DCreateEndpoint: function

Type declaration

AssetMappings3DDeleteEndpoint

AssetMappings3DDeleteEndpoint: function

Type declaration

AssetMappings3DListEndpoint

AssetMappings3DListEndpoint: function

AssetName

AssetName: string

Name of asset. Often referred to as tag.

AssetRetrieveEndpoint

AssetRetrieveEndpoint: function

Type declaration

AssetSearchEndpoint

AssetSearchEndpoint: function

Type declaration

AssetSource

AssetSource: string

The source of this asset

AssetUpdateEndpoint

AssetUpdateEndpoint: function

Type declaration

AutoPagingEach

AutoPagingEach: function

Type declaration

AutoPagingEachHandler

AutoPagingEachHandler: function

Type declaration

    • (item: T): false | true | void | Promise<void | boolean>
    • Parameters

      • item: T

      Returns false | true | void | Promise<void | boolean>

AutoPagingToArray

AutoPagingToArray: function

Type declaration

CREATE

CREATE: "CREATE"

CancelablePromise

CancelablePromise: object & Promise<T>

CogniteCapability

CogniteCapability: SingleCogniteCapability[]

CogniteExternalId

CogniteExternalId: string

External Id provided by client. Should be unique within the project.

CogniteInternalId

CogniteInternalId: number

CreateAssetMapping3D

CreateAssetMapping3D: AssetMapping3DBase

CursorAndAsyncIterator

CursorAndAsyncIterator: Promise<CursorResponse<T>> & CogniteAsyncIterator<T>

DELETE

DELETE: "DELETE"

DataPointsDeleteEndpoint

DataPointsDeleteEndpoint: function

Type declaration

DataPointsInsertEndpoint

DataPointsInsertEndpoint: function

Type declaration

DataPointsRetrieveEndpoint

DataPointsRetrieveEndpoint: function

DataPointsRetrieveLatestEndpoint

DataPointsRetrieveLatestEndpoint: function

Type declaration

DatapointsDeleteRequest

DatapointsGetDatapoint

DatapointsPostDatapoint

DatapointsQuery

DateRange

DateRange: Range<Timestamp>

DefaultGroupId

DefaultGroupId: number

A default group for all project users. Can be used to establish default capabilities. WARNING: this group may be logically deleted

DeleteAssetMapping3D

DeleteAssetMapping3D: AssetMapping3DBase

EXECUTE

EXECUTE: "EXECUTE"

EventChange

EventsCreateEndpoint

EventsCreateEndpoint: function

Type declaration

EventsDeleteEndpoint

EventsDeleteEndpoint: function

Type declaration

    • Parameters

      Returns Promise<__type>

EventsListEndpoint

EventsListEndpoint: function

Type declaration

EventsRetrieveEndpoint

EventsRetrieveEndpoint: function

Type declaration

EventsSearchEndpoint

EventsSearchEndpoint: function

Type declaration

EventsUpdateEndpoint

EventsUpdateEndpoint: function

Type declaration

FileChangeUpdate

FileContent

FileContent: ArrayBuffer | Buffer | any

FileMimeType

FileMimeType: string

File type. E.g. text/plain, application/pdf, ...

FileName

FileName: string

Name of the file.

Files3DRetrieveEndpoint

Files3DRetrieveEndpoint: function

Type declaration

FilesDeleteEndpoint

FilesDeleteEndpoint: function

Type declaration

    • Parameters

      Returns Promise<__type>

FilesGetDownloadUrlsEndpoint

FilesGetDownloadUrlsEndpoint: function

Type declaration

FilesListEndpoint

FilesListEndpoint: function

Type declaration

FilesRetrieveEndpoint

FilesRetrieveEndpoint: function

Type declaration

FilesSearchEndpoint

FilesSearchEndpoint: function

Type declaration

FilesUpdateEndpoint

FilesUpdateEndpoint: function

Type declaration

FilesUploadEndpoint

FilesUploadEndpoint: function

Type declaration

GroupName

GroupName: string

Name of the group

example

Production Engineers

GroupSourceId

GroupSourceId: string

ID of the group in the source. If this is the same ID as a group in the IDP, a user in that group will implicitly be a part of this group as well.

example

b7c9a5a4-99c2-4785-bed3-5e6ad9a78603

Groups

GroupsAddServiceAccountsEndpoint

GroupsAddServiceAccountsEndpoint: function

Type declaration

GroupsCreateEndpoint

GroupsCreateEndpoint: function

Type declaration

GroupsDeleteEndpoint

GroupsDeleteEndpoint: function

Type declaration

GroupsListEndpoint

GroupsListEndpoint: function

Type declaration

GroupsListServiceAccountsEndpoint

GroupsListServiceAccountsEndpoint: function

Type declaration

GroupsRemoveServiceAccountsEndpoint

GroupsRemoveServiceAccountsEndpoint: function

Type declaration

IdEither

IntegerRange

IntegerRange: Range<number>

Range between two integers

LIST

LIST: "LIST"

LatestDataBeforeRequest

LoginStatusEndpoint

LoginStatusEndpoint: function

Type declaration

MEMBEROF

MEMBEROF: "MEMBEROF"

Models3DCreateEndpoint

Models3DCreateEndpoint: function

Type declaration

Models3DDeleteEndpoint

Models3DDeleteEndpoint: function

Type declaration

Models3DListEndpoint

Models3DListEndpoint: function

Type declaration

Models3DRetrieveEndpoint

Models3DRetrieveEndpoint: function

Type declaration

Models3DUpdateEndpoint

Models3DUpdateEndpoint: function

Type declaration

NullableSinglePatchLong

NullableSinglePatchLong: object | object

NullableSinglePatchString

NullableSinglePatchString: object | object

ObjectPatch

ObjectPatch: object | object

OnAuthenticate

OnAuthenticate: function

Type declaration

OnTokens

OnTokens: function

Type declaration

    • (tokens: AuthTokens): void
    • Parameters

      • tokens: AuthTokens

      Returns void

ProjectName

ProjectName: string

The display name of the project.

example

Open Industrial Data

ProjectsRetrieveEndpoint

ProjectsRetrieveEndpoint: function

Type declaration

ProjectsUpdateEndpoint

ProjectsUpdateEndpoint: function

Type declaration

READ

READ: "READ"

RawCreateDatabasesEndpoint

RawCreateDatabasesEndpoint: function

Type declaration

RawCreateTablesEndpoint

RawCreateTablesEndpoint: function

Type declaration

    • (databaseName: string, items: RawDBTable[], ensureParent?: undefined | false | true): Promise<RawDBTable[]>
    • Parameters

      • databaseName: string
      • items: RawDBTable[]
      • Optional ensureParent: undefined | false | true

      Returns Promise<RawDBTable[]>

RawDeleteDatabasesEndpoint

RawDeleteDatabasesEndpoint: function

Type declaration

RawDeleteRowsEndpoint

RawDeleteRowsEndpoint: function

Type declaration

    • (databaseName: string, tableName: string, items: RawDBRowKey[]): Promise<__type>
    • Parameters

      • databaseName: string
      • tableName: string
      • items: RawDBRowKey[]

      Returns Promise<__type>

RawDeleteTablesEndpoint

RawDeleteTablesEndpoint: function

Type declaration

    • (databaseName: string, items: RawDBTable[]): Promise<__type>
    • Parameters

      Returns Promise<__type>

RawInsertRowsEndpoint

RawInsertRowsEndpoint: function

Type declaration

    • (databaseName: string, tableName: string, items: RawDBRowInsert[], ensureParent?: undefined | false | true): Promise<__type>
    • Parameters

      • databaseName: string
      • tableName: string
      • items: RawDBRowInsert[]
      • Optional ensureParent: undefined | false | true

      Returns Promise<__type>

RawListDatabasesEndpoint

RawListDatabasesEndpoint: function

Type declaration

RawListRowsEndpoint

RawListRowsEndpoint: function

Type declaration

RawListTablesEndpoint

RawListTablesEndpoint: function

Type declaration

RawRetrieveRowEndpoint

RawRetrieveRowEndpoint: function

Type declaration

    • (databaseName: string, tableName: string, rowKey: string): Promise<RawDBRow>
    • Parameters

      • databaseName: string
      • tableName: string
      • rowKey: string

      Returns Promise<RawDBRow>

Revisions3DCreateEndpoint

Revisions3DCreateEndpoint: function

Type declaration

Revisions3DDeleteEndpoint

Revisions3DDeleteEndpoint: function

Type declaration

Revisions3DListEndpoint

Revisions3DListEndpoint: function

Type declaration

Revisions3DListNodesAncestorsEndpoint

Revisions3DListNodesAncestorsEndpoint: function

Type declaration

Revisions3DListNodesEndpoint

Revisions3DListNodesEndpoint: function

Type declaration

Revisions3DRetrieveEndpoint

Revisions3DRetrieveEndpoint: function

Type declaration

Revisions3DUpdateEndpoint

Revisions3DUpdateEndpoint: function

Type declaration

Revisions3DUpdateThumbnailEndpoint

Revisions3DUpdateThumbnailEndpoint: function

Type declaration

SecurityCategoriesCreateEndpoint

SecurityCategoriesCreateEndpoint: function

Type declaration

SecurityCategoriesDeleteEndpoint

SecurityCategoriesDeleteEndpoint: function

Type declaration

SecurityCategoriesListEndpoint

SecurityCategoriesListEndpoint: function

ServiceAccountName

ServiceAccountName: string

Unique name of the service account

ServiceAccountsCreateEndpoint

ServiceAccountsCreateEndpoint: function

Type declaration

ServiceAccountsDeleteEndpoint

ServiceAccountsDeleteEndpoint: function

Type declaration

ServiceAccountsListEndpoint

ServiceAccountsListEndpoint: function

Type declaration

SingleCogniteCapability

SingleCogniteCapability: object | object | object | object | object | object | object | object | object | object | object | object | object

SinglePatchDate

SinglePatchDate: object | object

SinglePatchString

SinglePatchString: SetField<string> | RemoveField

TimeSeriesCreateEndpoint

TimeSeriesCreateEndpoint: function

Type declaration

TimeSeriesDeleteEndpoint

TimeSeriesDeleteEndpoint: function

Type declaration

TimeSeriesListEndpoint

TimeSeriesListEndpoint: function

Type declaration

TimeSeriesRetrieveEndpoint

TimeSeriesRetrieveEndpoint: function

Type declaration

TimeSeriesSearchEndpoint

TimeSeriesSearchEndpoint: function

Type declaration

TimeSeriesUpdate

TimeSeriesUpdateEndpoint

TimeSeriesUpdateEndpoint: function

Type declaration

TimeseriesIdEither

TimeseriesIdEither: InternalId | ExternalId

Timestamp

Timestamp: number | Date

Tuple3

Tuple3: T[]

UPDATE

UPDATE: "UPDATE"

UrlName

UrlName: string

The url name of the project. This is used as part of API calls. It should only contain letters, digits and hyphens, as long as the hyphens are not at the start or end.

example

publicdata

ValidDomains

ValidDomains: string[]

List of valid domains. If left empty, any user registered with the OAuth2 provider will get access.

Viewer3DListRevealNodeAncestorsEndpoint

Viewer3DListRevealNodeAncestorsEndpoint: function

Type declaration

Viewer3DListRevealNodes3DEndpoint

Viewer3DListRevealNodes3DEndpoint: function

Type declaration

Viewer3DListRevealSectorsEndpoint

Viewer3DListRevealSectorsEndpoint: function

Viewer3DRetrieveRevealRevisionEndpoint

Viewer3DRetrieveRevealRevisionEndpoint: function

Type declaration

Viewer3DRetrieveUnrealRevisionEndpoint

Viewer3DRetrieveUnrealRevisionEndpoint: function

Type declaration

WRITE

WRITE: "WRITE"

Variables

Const POPUP

POPUP: "POPUP" = "POPUP"

Const REDIRECT

REDIRECT: "REDIRECT" = "REDIRECT"

Functions

isLoginPopupWindow

  • isLoginPopupWindow(): boolean

loginPopupHandler

  • loginPopupHandler(): void