EndPoint Delete a Document by Id
Name
delete_document
Description
Deletes a 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
|
Output Columns
| Label |
DataType |
Length |
Raw |
Description |
| Id |
DT_WSTR |
4000 |
False |
|
| Status |
DT_WSTR |
4000 |
False |
|
| Table |
DT_WSTR |
4000 |
False |
|
| StatusCode |
DT_I4 |
0 |
False |
|
Input Columns
| Label |
DataType |
Length |
Raw |
Description |
| Id |
DT_WSTR |
4000 |
False |
|
