Skip to main content

@wildix/wim-knowledge-base-client > ListDocumentsInput

ListDocumentsInput interface

Signature:

export interface ListDocumentsInput 

Properties

Property

Modifiers

Type

Description

companyId?

string | undefined

(Optional) The unique identifier of the tenant when a service token is used.

dataSourceId

string

Unique identifier of the data source

limit?

number | undefined

(Optional)

offset?

number | undefined

(Optional)

originalId?

string | undefined

(Optional) Filter documents by original ID from the source system.

search?

string | undefined

(Optional) The search query string for filtering the documents results.

sort?

string | undefined

(Optional) Sort order of the results. If there is a '-' prefix, the results will be sorted in descending order. Otherwise, the results will be sorted in ascending order. Example: '-createdAt' will sort the results by createdAt in descending order. 'createdAt' will sort the results by createdAt in ascending order.

status?

DocumentStatus | undefined

(Optional) Filter documents by status.