publicación /acción/borrarUno

Elimine un único documento que coincida con una query.

Cuerpo

  • dataSource string Requerido

    El nombre de una fuente de datos de MongoDB Atlas vinculada. Esto es generalmente "mongodb-atlas" aunque puede ser diferente en tu aplicación si elegiste un nombre distinto al crear la fuente de datos.

  • database string Requerido

    El nombre de una base de datos en la fuente de datos especificada.

  • Colección string Requerido

    El nombre de una colección en la base de datos especificada.

  • filtro Objeto

    Un filtro de query de MongoDB que coincide con los documentos. Para ver una lista de todos los operadores del query que admite la API de datos, consulte Operadores del query.

Cuerpo

  • dataSource string Requerido

    El nombre de una fuente de datos de MongoDB Atlas vinculada. Esto es generalmente "mongodb-atlas" aunque puede ser diferente en tu aplicación si elegiste un nombre distinto al crear la fuente de datos.

  • database string Requerido

    El nombre de una base de datos en la fuente de datos especificada.

  • Colección string Requerido

    El nombre de una colección en la base de datos especificada.

  • filtro Objeto

    Un filtro de query de MongoDB que coincide con los documentos. Para ver una lista de todos los operadores del query que admite la API de datos, consulte Operadores del query.

Respuestas

  • Deleted

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • recuento eliminado Requerido

      El número de documentos que fueron borrados.

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • recuento eliminado Requerido

      El número de documentos que fueron borrados.

  • 400 aplicación/json

    La solicitud estaba mal formada o incompleta.

    Uno de:
  • 401 aplicación/json

    El usuario autenticado no tiene permiso para acceder a este punto final.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto

    Indica que ningún usuario coincide con las credenciales de autenticación proporcionadas.

    • Error string

      Un mensaje que describe el error.

      El valor es invalid session: error finding user for endpoint.

    • error_code string

      El tipo de error.

      El valor es InvalidSession.

PUBLICAR /acción/eliminarUno
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" }
    }
  }'
Ejemplo de solicitud
{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas"
}
Ejemplo de solicitud
{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas"
}
Ejemplos de respuestas (200)
{
  "deletedCount": 1
}
Ejemplos de respuestas (200)
{
  "deletedCount": {
    "$numberInt": 1
  }
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (401)
{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}