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

    Interface GetDocumentAsRelatedParams

    Parameters for the getDocumentAsRelated operation.

    interface GetDocumentAsRelatedParams {
        attachments?: boolean;
        attEncodingInfo?: boolean;
        conflicts?: boolean;
        db: string;
        deletedConflicts?: boolean;
        docId: string;
        headers?: OutgoingHttpHeaders;
        ifNoneMatch?: string;
        latest?: boolean;
        localSeq?: boolean;
        meta?: boolean;
        rev?: string;
        revs?: boolean;
        revsInfo?: boolean;
        signal?: GenericAbortSignal;
    }

    Hierarchy

    • DefaultParams
      • GetDocumentAsRelatedParams
    Index

    Properties

    attachments? attEncodingInfo? conflicts? db deletedConflicts? docId headers? ifNoneMatch? latest? localSeq? meta? rev? revs? revsInfo? signal?

    Properties

    attachments?: boolean

    Query parameter to specify whether to include attachment content in the response. Note that when used with a view-style query or changes feed this only applies when requesting documents in the response.

    attEncodingInfo?: boolean

    Query parameter to specify whether to include the encoding information for compressed attachments. Note that when used with a view-style query or changes feed this only applies when requesting documents in the response.

    conflicts?: boolean

    Query parameter to specify whether to include a list of conflicted revisions in each returned document. Note that when used with a view-style query or changes feed this only applies when requesting documents in the response.

    db: string

    Path parameter to specify the database name.

    deletedConflicts?: boolean

    Query parameter to specify whether to include a list of deleted conflicted revisions in the _deleted_conflicts property of the returned document.

    docId: string

    Path parameter to specify the document ID.

    headers?: OutgoingHttpHeaders
    ifNoneMatch?: string

    Header parameter for a conditional HTTP request not matching an ETag.

    latest?: boolean

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

    localSeq?: boolean

    Query parameter to specify whether to include the last update sequence for the document.

    meta?: boolean

    Query parameter to specify whether to include document meta information. Acts the same as specifying all of the conflicts, deleted_conflicts and open_revs query parameters.

    rev?: string

    Query parameter to specify a document revision.

    revs?: boolean

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

    revsInfo?: boolean

    Query parameter to specify whether to includes detailed information for all known document revisions.

    signal?: GenericAbortSignal

    Settings

    Member Visibility

    On This Page

    Properties