Type Alias QueryOptions

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;
}

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

Type declaration

  • Optionalcount?: number

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

  • Optionalforms?: 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

  • OptionalincludeFormAlias?: boolean

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

  • OptionalmarkRead?: boolean

    Mark documents as read by the current user when retrieved

  • OptionalmaxScanDocs?: number

    Limits the number of documents to be scanned.

  • OptionalmaxScanEntries?: number

    Limits the number of entries to be scanned.

  • Optionalmode?: string

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

  • OptionalnoViews?: boolean

    Disable use of views when true.

  • query: string

    DQL query string.

  • replaceItems: { [key: string]: any }

    Key-value pairs of form data to update.

  • OptionalreturnUpdatedDocument?: boolean

    If true, replaces the operation response to array of DominoDocument

  • Optionalstart?: number

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

  • OptionaltimeoutSecs?: number

    Query timeout in seconds.

  • Optionalvariables?: { [key: string]: any }

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

  • OptionalviewRefresh?: boolean

    Should views get refreshed after operation execution.

Settings

Member Visibility