EndPoint Delete a Document by Id

Name

delete_document

Deletes a Document by Id. [API reference]

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)

The partition key value for the document. Must be included if and only if the collection is created with a partitionKey definition

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
Status	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
Table	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
StatusCode	`DT_I4`	`int`		`False`

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Required columns that you need to supply are bolded.

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

This EndPoint belongs to [Dynamic Table] table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Cosmos DB

[Dynamic Table]

Delete