查找文档

发布 /action/find

访问令牌电子邮件和密码 Api key Custom jwt

查找多个与查询匹配的文档。

body

dataSource 字符串必需

链接的 MongoDB Atlas 数据源的名称。它通常为 "mongodb-atlas"，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 字符串必需

指定的数据源中的数据库名称。
集合字符串必需

指定的数据库中的集合名称。
筛选器对象

匹配文档的 MongoDB 查询筛选条件。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
投影对象

操作返回的匹配文档的 MongoDB 投影。
隐藏投影属性显示投影属性对象
- * 数字 additionalProperties
  
  值为 0 或 1。
sort 对象

指示排序的字段名称和方向的 MongoDB 排序表达式。
limit 数字

响应中包含的匹配文档的最大数量。
跳过数字

要从响应中忽略的匹配文档的数量。

body

dataSource 字符串必需

链接的 MongoDB Atlas 数据源的名称。它通常为 "mongodb-atlas"，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 字符串必需

指定的数据源中的数据库名称。
集合字符串必需

指定的数据库中的集合名称。
筛选器对象

匹配文档的 MongoDB 查询筛选条件。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
投影对象

操作返回的匹配文档的 MongoDB 投影。
隐藏投影属性显示投影属性对象
- * 数字 additionalProperties
  
  值为 0 或 1。
sort 对象

指示排序的字段名称和方向的 MongoDB 排序表达式。
limit 数字

响应中包含的匹配文档的最大数量。
跳过数字

要从响应中忽略的匹配文档的数量。

响应

200

application/json

application/json application/ejson

Found
隐藏响应属性显示响应属性对象
- 文档大量[对象]
  
  与指定过滤匹配的文档列表。
隐藏响应属性显示响应属性对象
- 文档大量[对象]
  
  与指定过滤匹配的文档列表。
400 application/json

请求格式不正确或不完整。
以下之一：
ErrorNoAuthenticationSpecified对象 ErrorMissingAuthenticationParameter 对象
表示请求不包含任何身份验证凭证。

隐藏属性显示属性

错误字符串

描述错误的消息。

值为 no authentication methods were specified。

error_code 字符串

错误类型。

值为 InvalidParameter。

链接字符串

指向失败操作的日志条目的链接。
表示请求正文或标头中缺少身份验证参数。示例，请求可能包含 email 标头，但没有相应的 password 标头。

隐藏属性显示属性

错误字符串

描述错误的消息。

值为 must specify some form of authentication (either email+password, api-key, or jwt) in the request header or body。

error_code 字符串

错误类型。

值为 MissingParameter。

链接字符串

指向失败操作的日志条目的链接。
401 application/json

经过身份验证的用户没有访问权限此端点的权限。
隐藏响应属性显示响应属性对象
表示没有用户与提供的身份验证凭证匹配。
- 错误字符串
  
  描述错误的消息。
  
  值为 invalid session: error finding user for endpoint。
- error_code 字符串
  
  错误类型。
  
  值为 InvalidSession。
- 链接字符串
  
  指向失败操作的日志条目的链接。

POST /动作/find

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
  }'

请求示例

{
  "sort": {
    "completedAt": 1
  },
  "limit": 10,
  "filter": {
    "status": "complete"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "completedAt": 1
  }
}

请求示例

{
  "sort": {
    "completedAt": 1
  },
  "limit": 10,
  "filter": {
    "status": "complete"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "completedAt": 1
  }
}

响应示例 (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"
    }
  ]
}

响应示例 (200)

{
  "documents": [
    {
      "_id": {
        "$oid": "6193504e1be4ab27791c8133"
      },
      "text": "Do the dishes",
      "completedAt": {
        "$date": {
          "$numberLong": "1652732521104"
        }
      }
    },
    {
      "_id": {
        "$oid": "6194604e1d38dc33792d8257"
      },
      "text": "Feed the dog",
      "completedAt": {
        "$date": {
          "$numberLong": "1652764362828"
        }
      }
    }
  ]
}

响应示例 (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"
}

响应示例 (401)

{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}