Excluir um documento

POSTAR /action/deleteOne
Token de acesso E-mail e senha Api key Custom jwt

Exclua um único documento que corresponda a uma query.

corpo, corpo

  • dataSource string Obrigatório

    O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é "mongodb-atlas", embora isso possa mudar em seu aplicativo se você tiver escolhido outro nome ao criar a fonte de dados.

  • database string Obrigatório

    O nome de um banco de dados na fonte de dados especificada.

  • collection string Obrigatório

    O nome de uma collection no banco de dados especificado.

  • filtro, filtro objeto

    Um filtro de queries do MongoDB que corresponda aos documentos. Para obter uma lista de todos os operadores de query compatíveis com a Data API, consulte Operadores de query.

corpo, corpo

  • dataSource string Obrigatório

    O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é "mongodb-atlas", embora isso possa mudar em seu aplicativo se você tiver escolhido outro nome ao criar a fonte de dados.

  • database string Obrigatório

    O nome de um banco de dados na fonte de dados especificada.

  • collection string Obrigatório

    O nome de uma collection no banco de dados especificado.

  • filtro, filtro objeto

    Um filtro de queries do MongoDB que corresponda aos documentos. Para obter uma lista de todos os operadores de query compatíveis com a Data API, consulte Operadores de query.

Respostas

  • 200

    Excluído

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • deleteCount Obrigatório

      O número de documentos que foram excluídos.

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • deleteCount Obrigatório

      O número de documentos que foram excluídos.
  • 400 aplicação/json

    A solicitação estava malformada ou incompleta.

    Um dos seguintes:
    objeto ErrorNoAuthenticationSpecified objeto ErrorMissingAuthenticationParameter
  • 401 aplicação/json

    O usuário autenticado não tem permissão para acessar este endpoint.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto

    Indica que nenhum usuário correspondeu às credenciais de autenticação fornecidas.

    • Erro string

      Uma mensagem que descreve o erro.

      O valor é invalid session: error finding user for endpoint.

    • error_code string

      O tipo de erro.

      O valor é InvalidSession.

    • link string

      Um link para uma entrada de registro da operação com falha.
POST /ação/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" }
    }
  }'
exemplo de solicitação 
{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas"
}
exemplo de solicitação 
{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas"
}
Exemplos de resposta (200) 
{
  "deletedCount": 1
}
Exemplos de resposta (200) 
{
  "deletedCount": {
    "$numberInt": 1
  }
}
Exemplos de resposta (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"
}
Exemplos de resposta (401) 
{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}