publicación /acción/encontrarUno
Token de acceso Correo electrónico y contraseña Api key Custom jwt

Encuentra 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.

  • proyección Objeto

    Una proyección de MongoDB para los documentos que coinciden devueltos por la operación.

    Ocultar el atributo de proyección Mostrar atributo de proyección Objeto
    • * Número Propiedades adicionales

      Los valores son 0 o 1.

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.

  • proyección Objeto

    Una proyección de MongoDB para los documentos que coinciden devueltos por la operación.

    Ocultar el atributo de proyección Mostrar atributo de proyección Objeto
    • * Número Propiedades adicionales

      Los valores son 0 o 1.

Respuestas

  • 200

    Found

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • Documento objeto | nulo

      Un documento que coincide con el filtro especificado. Si no hay documentos que coincidan, esto es null.

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • Documento objeto | nulo

      Un documento que coincide con el filtro especificado. Si no hay documentos que coincidan, esto es null.
  • 400 application/json

    La solicitud estaba malformada o incompleta.

    Uno de los siguientes:
    object-2 objeto object-2 objeto
  • 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.

    • enlace string

      Un enlace a una entrada de registro para la operación fallida.
POST /action/findOne 
curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/findOne" \
  -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": {
      "text": "Do the dishes"
    }
  }'
Ejemplo de solicitud 
{
  "dataSource": "mongodb-atlas",
  "database": "todo",
  "collection": "tasks",
  "filter": {
    "text": "Do the dishes"
  },
  "projection": {
    "status": 1,
    "text": 1
  }
}
Ejemplo de solicitud 
{
  "dataSource": "mongodb-atlas",
  "database": "todo",
  "collection": "tasks",
  "filter": {
    "text": "Do the dishes"
  },
  "projection": {
    "status": 1,
    "text": 1
  }
}
Ejemplos de respuesta (200) 
{
  "document": {
    "_id": "6193504e1be4ab27791c8133",
    "status": "open",
    "text": "Do the dishes"
  }
}
Ejemplos de respuesta (200) 
{
  "document": {
    "_id": {
      "$oid": "6193504e1be4ab27791c8133"
    },
    "status": "open",
    "text": "Do the dishes"
  }
}
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"
}