Parameters for the getDocumentAsRelated operation.

Hierarchy

  • GetDocumentAsRelatedParams

Properties

attEncodingInfo?: boolean

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

attachments?: boolean

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

conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when include_docs is true.

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 to specify a double quoted document revision token for cache control.

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.

Generated using TypeDoc