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

Encontrar vários documentos que correspondam 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.

  • projeção objeto

    Uma projeção do MongoDB para documentos correspondentes retornados pela operação.

    Ocultar atributo de projeção Mostrar atributo de projeção objeto
    • * número Propriedades adicionais

      Os valores são 0 ou 1.

  • sort objeto

    Uma expressão de classificação do MongoDB que indica nomes e direções de campos classificados.

  • limit número

    O número máximo de documentos correspondentes para incluir na resposta.

  • ignorar número

    O número de documentos correspondentes para omitir da resposta.

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.

  • projeção objeto

    Uma projeção do MongoDB para documentos correspondentes retornados pela operação.

    Ocultar atributo de projeção Mostrar atributo de projeção objeto
    • * número Propriedades adicionais

      Os valores são 0 ou 1.

  • sort objeto

    Uma expressão de classificação do MongoDB que indica nomes e direções de campos classificados.

  • limit número

    O número máximo de documentos correspondentes para incluir na resposta.

  • ignorar número

    O número de documentos correspondentes para omitir da resposta.

Respostas

  • 200

    Encontrado

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • documentos array[objeto]

      Uma lista de documentos que correspondem ao filtro especificado.

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • documentos array[objeto]

      Uma lista de documentos que correspondem ao filtro especificado.
  • 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/localizar 
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
  }'
exemplo de solicitação 
{
  "sort": {
    "completedAt": 1
  },
  "limit": 10,
  "filter": {
    "status": "complete"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "completedAt": 1
  }
}
exemplo de solicitação 
{
  "sort": {
    "completedAt": 1
  },
  "limit": 10,
  "filter": {
    "status": "complete"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "completedAt": 1
  }
}
Exemplos de resposta (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"
    }
  ]
}
Exemplos de resposta (200) 
{
  "documents": [
    {
      "_id": {
        "$oid": "6193504e1be4ab27791c8133"
      },
      "text": "Do the dishes",
      "completedAt": {
        "$date": {
          "$numberLong": "1652732521104"
        }
      }
    },
    {
      "_id": {
        "$oid": "6194604e1d38dc33792d8257"
      },
      "text": "Feed the dog",
      "completedAt": {
        "$date": {
          "$numberLong": "1652764362828"
        }
      }
    }
  ]
}
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"
}