Cosmos DB Connector
Documentation
Version: 2
Documentation

EndPoint Get Document by Id


Name

get_document

Description

Gets Document by Id. [API Help]

Parameters

Parameter Label Required Options Description
Id Document Id YES
Table Table Name (Case-Sensitive) YES
Database Database Name (keep blank to use default) Case-Sensitive NO Leave blank to use default DB set on connection screen
EnableCrossPartition EnableCrossPartition NO
Option Value
true true
false false
PartitionKey Partition Key Value (default is supplied Id) NO
Option Value
Default .
SingleKeyValue ["someValue1"]
MultiKeyValue ["some_value1","some_value2" ]
The partition key value for the document. Must be included if and only if the collection is created with a partitionKey definition
ConsistencyLevel ConsistencyLevel NO
Option Value
Strong Strong
Bounded Bounded
Session Session
Eventual Eventual
This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). The override must be the same or weaker than the account’s configured consistency level.

Output Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.