删除一个文档

发布 /action/deleteOne
访问令牌 电子邮件和密码 Api key Custom jwt

删除一个与查询匹配的文档。

body

  • dataSource 字符串 必需

    链接的 MongoDB Atlas 数据源的名称。它通常为 "mongodb-atlas"，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。

  • database 字符串 必需

    指定的数据源中的数据库名称。

  • 集合 字符串 必需

    指定的数据库中的集合名称。

  • 筛选器 对象

    匹配文档的 MongoDB 查询筛选条件。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。

body

  • dataSource 字符串 必需

    链接的 MongoDB Atlas 数据源的名称。它通常为 "mongodb-atlas"，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。

  • database 字符串 必需

    指定的数据源中的数据库名称。

  • 集合 字符串 必需

    指定的数据库中的集合名称。

  • 筛选器 对象

    匹配文档的 MongoDB 查询筛选条件。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。

响应

  • 200

    Deleted

    隐藏响应属性 显示响应属性 对象
    • DeletedCount 必需

      已删除的文档数量。

    隐藏响应属性 显示响应属性 对象
    • DeletedCount 必需

      已删除的文档数量。
  • 400 application/json

    请求格式不正确或不完整。

    以下之一：
    ErrorNoAuthenticationSpecified对象 ErrorMissingAuthenticationParameter 对象
  • 401 application/json

    经过身份验证的用户没有访问权限此端点的权限。

    隐藏响应属性 显示响应属性 对象

    表示没有用户与提供的身份验证凭证匹配。

    • 错误 字符串

      描述错误的消息。

      值为 invalid session: error finding user for endpoint。

    • error_code 字符串

      错误类型。

      值为 InvalidSession。

    • 链接 字符串

      指向失败操作的日志条目的链接。
POST /动作/deleteOne 
curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/deleteOne" \
  -X POST \
  -H "apiKey: $API_KEY" \
  -H 'Content-Type: application/ejson' \
  -H "Accept: application/json" \
  -d '{
    "dataSource": "mongodb-atlas",
    "database": "learn-data-api",
    "collection": "tasks",
    "filter": {
      "_id": { "$oid": "64224f3cd79f54ad342dd9b2" }
    }
  }'
请求示例 
{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas"
}
请求示例 
{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas"
}
响应示例 (200) 
{
  "deletedCount": 1
}
响应示例 (200) 
{
  "deletedCount": {
    "$numberInt": 1
  }
}
响应示例 (400) 
{
  "error": "no authentication methods were specified",
  "error_code": "InvalidParameter",
  "link": "string"
}
{
  "error": "must specify some form of authentication (either email+password, api-key, or jwt) in the request header or body",
  "error_code": "MissingParameter",
  "link": "string"
}
响应示例 (401) 
{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}