PutReplicationDocumentParams | @ibm-cloud/cloudant

Parameters for the putReplicationDocument operation.

Hierarchy

PutReplicationDocumentParams

Index

Properties

batch
docId
headers
ifMatch
newEdits
replicationDocument
rev

Properties

Optional batch

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

docId

docId: string

Path parameter to specify the document ID.

Optional headers

headers?: OutgoingHttpHeaders

Optional ifMatch

ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

Optional newEdits

newEdits?: boolean

Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a well-formed _rev must be included in the document. False is used by the replicator to insert documents into the target database even if that leads to the creation of conflicts.

replicationDocument

replicationDocument: export=.ReplicationDocument

HTTP request body for replication operations.

Optional rev

rev?: string

Query parameter to specify a document revision.