Interface BTDocumentSearchParams

Export

Interface

BTDocumentSearchParams

Hierarchy

  • BTDocumentSearchParams

Properties

documentFilter? foundIn? limit? luceneSyntax? offset? ownerId? parentId? rawQuery? sortColumn? sortOrder? type? when?

Properties

Optional documentFilter

documentFilter?: number

Filter ID. Options are 0 (my documents), 1 (created), 2 (shared), 3 (trash), 4 (public), 5 (recent), 6 (by owner), 7 (by company), or 9 (by team).

Memberof

BTDocumentSearchParams

Optional foundIn

foundIn?: BTESVersionWorkspaceChoice

Memberof

BTDocumentSearchParams

Optional limit

limit?: number

Number of results to return per page. Default value is 20 (also the maximum).

Memberof

BTDocumentSearchParams

Optional luceneSyntax

luceneSyntax?: boolean

Lucene syntax

Memberof

BTDocumentSearchParams

Optional offset

offset?: number

Offset. Determines where search results begin. Default value is 0.

Memberof

BTDocumentSearchParams

Optional ownerId

ownerId?: string

Document owner's ID (if the filter is 6 or 7), or Team Id (if the filter is 9)

Memberof

BTDocumentSearchParams

Optional parentId

parentId?: string

Search document parent Id

Memberof

BTDocumentSearchParams

Optional rawQuery

rawQuery?: string

Search for documents that contain the given string in the name. Search is not case-sensitive.

Memberof

BTDocumentSearchParams

Optional sortColumn

sortColumn?: string

Column by which to sort search results. Options are name, modifiedAt, createdAt (Default), email, modifiedBy, and promotedAt.

Memberof

BTDocumentSearchParams

Optional sortOrder

sortOrder?: string

Sort order. Options are desc (descending, the default), or asc (ascending).

Memberof

BTDocumentSearchParams

Optional type

type?: string

Type of owner. Options are 0 (user), 1 (company), 2 (onshape). If the owner is a teamId, leave this unspecified.

Memberof

BTDocumentSearchParams

Optional when

when?: BTESResultsFilter

Memberof

BTDocumentSearchParams

Settings

Member Visibility

Theme

Generated using TypeDoc