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

Encuentre varios documentos que coincidan con una consulta.

Cuerpo

  • dataSource string Requerido

    El nombre de una fuente de datos de MongoDB Atlas vinculada. Suele ser "mongodb-atlas", aunque puede ser diferente en tu aplicación si elegiste un nombre diferente 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 consulta de MongoDB que busca documentos. Para obtener una lista de todos los operadores de consulta compatibles con la API de datos, consulte Operadores de consulta.

  • proyección Objeto

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

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

      Los valores son 0 o 1.

  • sort Objeto

    Una expresión de ordenamiento de MongoDB que indica nombres de campos ordenados y direcciones.

  • limit Número

    El número máximo de documentos coincidentes para incluir en la respuesta.

  • Omitir Número

    El número de documentos coincidentes que se omitirán de la respuesta.

Cuerpo

  • dataSource string Requerido

    El nombre de una fuente de datos de MongoDB Atlas vinculada. Suele ser "mongodb-atlas", aunque puede ser diferente en tu aplicación si elegiste un nombre diferente 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 consulta de MongoDB que busca documentos. Para obtener una lista de todos los operadores de consulta compatibles con la API de datos, consulte Operadores de consulta.

  • proyección Objeto

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

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

      Los valores son 0 o 1.

  • sort Objeto

    Una expresión de ordenamiento de MongoDB que indica nombres de campos ordenados y direcciones.

  • limit Número

    El número máximo de documentos coincidentes para incluir en la respuesta.

  • Omitir Número

    El número de documentos coincidentes que se omitirán de la respuesta.

Respuestas

  • 200

    Encontrados

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • Documentos matriz[objeto]

      Una lista de documentos que coinciden con el filtro especificado.

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • Documentos matriz[objeto]

      Una lista de documentos que coinciden con el filtro especificado.
  • 400 aplicación/json

    La solicitud estaba mal formada o incompleta.

    Uno de:
    Objeto ErrorNoAuthenticationSpecified Objeto ErrorMissingAuthenticationParameter
  • 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 coincidió 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 de la operación fallida.
POST /acción/buscar 
curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/find" \
  -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": {
      "status": "complete"
    },
    "sort": { "completedAt": 1 },
    "limit": 10
  }'
Ejemplo de solicitud 
{
  "sort": {
    "completedAt": 1
  },
  "limit": 10,
  "filter": {
    "status": "complete"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "completedAt": 1
  }
}
Ejemplo de solicitud 
{
  "sort": {
    "completedAt": 1
  },
  "limit": 10,
  "filter": {
    "status": "complete"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "completedAt": 1
  }
}
Ejemplos de respuestas (200) 
{
  "documents": [
    {
      "_id": "6193504e1be4ab27791c8133",
      "text": "Do the dishes",
      "completedAt": "2022-05-16T20:22:01.104Z"
    },
    {
      "_id": "6194604e1d38dc33792d8257",
      "text": "Feed the dog",
      "completedAt": "2022-05-17T05:12:42.828Z"
    }
  ]
}
Ejemplos de respuestas (200) 
{
  "documents": [
    {
      "_id": {
        "$oid": "6193504e1be4ab27791c8133"
      },
      "text": "Do the dishes",
      "completedAt": {
        "$date": {
          "$numberLong": "1652732521104"
        }
      }
    },
    {
      "_id": {
        "$oid": "6194604e1d38dc33792d8257"
      },
      "text": "Feed the dog",
      "completedAt": {
        "$date": {
          "$numberLong": "1652764362828"
        }
      }
    }
  ]
}
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"
}