DocumentsAPI | Cognite JavaScript SDK

Hierarchy

BaseResourceAPI<Document>
- DocumentsAPI

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new DocumentsAPI(...args: [string, CDFHttpClient, MetadataMap]): DocumentsAPI

Overrides BaseResourceAPI.__constructor
- Defined in packages/stable/src/api/documents/documentsApi.ts:23
Parameters
- Rest ...args: [string, CDFHttpClient, MetadataMap]
Returns DocumentsAPI

Accessors

aggregate

get aggregate(): DocumentsAggregateAPI

- Defined in packages/stable/src/api/documents/documentsApi.ts:41
Returns DocumentsAggregateAPI

preview

get preview(): PreviewAPI

- Defined in packages/stable/src/api/documents/documentsApi.ts:37
Returns PreviewAPI

Methods

const documents = await client.documents.search({
  search: {
    query: 'Stuck pipe'
  },
  filter: {
    in: {
      property: ['type'],
      values: ['Document', 'PDF']
    }
  },
  limit: 5
});

Parameters

query: DocumentSearchRequest

Class DocumentsAPI

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Rest ...args: [string, CDFHttpClient, MetadataMap]

Returns DocumentsAPI

Accessors

aggregate

Returns DocumentsAggregateAPI

preview

Returns PreviewAPI

Methods

content

Parameters

id: CogniteInternalId

Returns Promise<string>

list

Parameters

request: DocumentListRequest

Returns DocumentListResponse

search

Parameters

query: DocumentSearchRequest

Returns Promise<DocumentSearchResponse>