@hcl-software/domino-rest-sdk-node
    Preparing search index...

    Type Alias QueryOptions

    Possible Properties inside a request body of /bulk/update and /query

    type QueryOptions = {
        count?: number;
        forms?: string[];
        includeFormAlias?: boolean;
        markRead?: boolean;
        maxScanDocs?: number;
        maxScanEntries?: number;
        mode?: string;
        noViews?: boolean;
        query: string;
        replaceItems: { [key: string]: any };
        returnUpdatedDocument?: boolean;
        start?: number;
        timeoutSecs?: number;
        variables?: { [key: string]: any };
        viewRefresh?: boolean;
    }
    Index

    Properties

    count? forms? includeFormAlias? markRead? maxScanDocs? maxScanEntries? mode? noViews? query replaceItems returnUpdatedDocument? start? timeoutSecs? variables? viewRefresh?

    Properties

    count?: number

    Indicates how many responses the operation will return. Default is maxInt.

    forms?: string[]

    List of form names to be added to the query. Domino REST API will lookup all potential alias values and add them to the query clause

    includeFormAlias?: boolean

    If form names added to the query, this parameter will indicate whether all form alias should be included in the query clause.

    markRead?: boolean

    Mark documents as read by the current user when retrieved

    maxScanDocs?: number

    Limits the number of documents to be scanned.

    maxScanEntries?: number

    Limits the number of entries to be scanned.

    mode?: string

    Form mode as configured for any of the forms returned by the query.

    noViews?: boolean

    Disable use of views when true.

    query: string

    DQL query string.

    replaceItems: { [key: string]: any }

    Key-value pairs of form data to update.

    returnUpdatedDocument?: boolean

    If true, replaces the operation response to array of DominoDocument

    start?: number

    Indicates how many documents will the operation skip on the matched documents. Default is 0.

    timeoutSecs?: number

    Query timeout in seconds.

    variables?: { [key: string]: any }

    Key-value to replace ?<variable_name> in query.

    viewRefresh?: boolean

    Should views get refreshed after operation execution.

    Settings

    Member Visibility

    On This Page

    Properties