EndPoint Get Document by Id

Name

get_document

Description

Gets Document by Id. [API reference]

Parameters

Parameter

Label

Required

Options

Description

Document Id

YES

Table

Table Name (Case-Sensitive)

YES

Database

Database Name (keep blank to use default) Case-Sensitive

Leave blank to use default DB set on connection screen

EnableCrossPartition

Option	Value
true	true
false	false

PartitionKey

Partition Key Value (default is supplied Id)

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

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	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Cosmos DB Connector in API Source component to read data or in API Destination component to read/write data:

Get Document by Id using API Source

Cosmos DB

Get Document by Id

SSIS API Source - Read from table or endpoint

Get Document by Id using API Destination

Cosmos DB

Get Document by Id