@ibm-cloud/cloudant - v0.12.6
    Preparing search index...

    Interface PostBulkGetParams

    Parameters for the postBulkGet operation.

    interface PostBulkGetParams {
        attachments?: boolean;
        attEncodingInfo?: boolean;
        db: string;
        docs: CloudantV1.BulkGetQueryDocument[];
        headers?: OutgoingHttpHeaders;
        latest?: boolean;
        revs?: boolean;
        signal?: GenericAbortSignal;
    }

    Hierarchy

    • DefaultParams
      • PostBulkGetParams
    Index

    Properties

    attachments?: boolean

    Query parameter to specify whether to include attachments bodies in a response.

    attEncodingInfo?: boolean

    Query parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is compressed.

    db: string

    Path parameter to specify the database name.

    List of document items to get in bulk.

    headers?: OutgoingHttpHeaders
    latest?: boolean

    Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.

    revs?: boolean

    Query parameter to specify whether to include a list of all known document revisions.

    signal?: GenericAbortSignal