publicación /action/updateOne

Actualiza un solo documento en una colección.

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.

  • update Objeto Requerido

    Una expresión de actualización de MongoDB para aplicar a los documentos coincidentes. Para obtener una lista de todos los operadores de actualización que admite la API de datos, consulta Operadores de actualización.

  • inserción booleano

    Cuando true, si el filtro de actualización no coincide con ningún documento existente, entonces inserta un nuevo documento basado en el filtro y en la operación de actualización especificada.

    El valor por defecto es false.

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.

  • update Objeto Requerido

    Una expresión de actualización de MongoDB para aplicar a los documentos coincidentes. Para obtener una lista de todos los operadores de actualización que admite la API de datos, consulta Operadores de actualización.

  • inserción booleano

    Cuando true, si el filtro de actualización no coincide con ningún documento existente, entonces inserta un nuevo documento basado en el filtro y en la operación de actualización especificada.

    El valor por defecto es false.

Respuestas

  • actualizar

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • matchedCount Requerido

      El número de documentos que cumple con el filtro de query.

    • modifiedCount Requerido

      El número de documentos coincidentes que fueron modificados.

    • upsertedId string

      El valor de _id del documento actualizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • matchedCount Requerido

      El número de documentos que cumple con el filtro de query.

    • modifiedCount Requerido

      El número de documentos coincidentes que fueron modificados.

    • upsertedId string

      El valor de _id del documento actualizado.

  • 400 application/json

    La solicitud estaba malformada o incompleta.

    Uno de los siguientes:
  • 401 application/json

    El usuario autenticado no tiene permiso para acceder a este endpoint.

    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.

POST /action/updateOne
curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/updateOne" \
  -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": "64224f4d089104f1766116a5" }
    },
    "update": {
      "$set": {
        "status": "complete",
        "completedAt": { "$date": { "$numberLong": "1680105272788" } }
      }
    }
  }'
Ejemplo de solicitud
{
  "dataSource": "mongodb-atlas",
  "database": "todo",
  "collection": "tasks",
  "filter": {
    "_id": {
      "$oid": "642f1bb5cee4111898828bf6"
    }
  },
  "update": {
    "$set": {
      "status": "complete"
    }
  },
  "upsert": false
}
Ejemplo de solicitud
{
  "dataSource": "mongodb-atlas",
  "database": "todo",
  "collection": "tasks",
  "filter": {
    "_id": {
      "$oid": "642f1bb5cee4111898828bf6"
    }
  },
  "update": {
    "$set": {
      "status": "complete"
    }
  },
  "upsert": false
}
Ejemplos de respuesta (200)
{
  "matchedCount": 1,
  "modifiedCount": 1
}
Ejemplos de respuesta (200)
{
  "matchedCount": {
    "$numberInt": "1"
  },
  "modifiedCount": {
    "$numberInt": "1"
  }
}
Ejemplos de respuesta (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 respuesta (401)
{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}