ドキュメントの検索

POST /action/find

アクセストークンメールとパスワード Api key Custom jwt

クエリに一致する複数のドキュメントを検索します。

body

dataSource string 必須

リンクされた MongoDB Atlas データソースの名前。これは通常"mongodb-atlas"ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database string 必須

指定されたデータソース内のデータベースの名前。
コレクション string 必須

指定したデータベース内のコレクションの名前。
フィルターオブジェクト

ドキュメントに一致するMongoDBクエリフィルター。データAPI がサポートするすべてのクエリ演算子のリストについては、クエリ演算子を参照してください。
プロジェクションオブジェクト

操作によって返された一致したドキュメントのMongoDBプロジェクション。
プロジェクション属性を非表示プロジェクション属性の表示オブジェクト
- * 数値 additionalProperties
  
  値は 0 または 1 です。
sort オブジェクト

ソートされたフィールド名と方向を示すMongoDBソート式。
limit 数値

応答に含める一致するドキュメントの最大数。
スキップ数値

応答から省略する一致するドキュメントの数。

body

dataSource string 必須

リンクされた MongoDB Atlas データソースの名前。これは通常"mongodb-atlas"ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database string 必須

指定されたデータソース内のデータベースの名前。
コレクション string 必須

指定したデータベース内のコレクションの名前。
フィルターオブジェクト

ドキュメントに一致するMongoDBクエリフィルター。データAPI がサポートするすべてのクエリ演算子のリストについては、クエリ演算子を参照してください。
プロジェクションオブジェクト

操作によって返された一致したドキュメントのMongoDBプロジェクション。
プロジェクション属性を非表示プロジェクション属性の表示オブジェクト
- * 数値 additionalProperties
  
  値は 0 または 1 です。
sort オブジェクト

ソートされたフィールド名と方向を示すMongoDBソート式。
limit 数値

応答に含める一致するドキュメントの最大数。
スキップ数値

応答から省略する一致するドキュメントの数。

応答

200

application/ JSON

application/ JSON application/ EJSON

見つかりました
応答属性を非表示応答属性の表示オブジェクト
- ドキュメント array[オブジェクト]
  
  指定したフィルターに一致するドキュメントのリスト。
応答属性を非表示応答属性の表示オブジェクト
- ドキュメント array[オブジェクト]
  
  指定したフィルターに一致するドキュメントのリスト。
400 application/ JSON

リクエストの形式が正しくないか、不完全でした。
次の 1 つ：
ErrorNoAuthenticationSpecified オブジェクト ErrorMissingAuthenticationParameter オブジェクト
リクエストに認証情報が含まれていないことを示します。

属性を非表示属性を表示

エラー string

エラーを説明するメッセージ。

値は no authentication methods were specified です。

error_code string

エラーの種類。

値は InvalidParameter です。

リンク string

失敗した操作のログエントリへのリンク。
リクエスト本文またはヘッダーから認証パラメータが欠落していることを示します。例、リクエストには email ヘッダーは含まれているが、対応する password ヘッダーは含まれていない場合があります。

属性を非表示属性を表示

エラー string

エラーを説明するメッセージ。

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

error_code string

エラーの種類。

値は MissingParameter です。

リンク string

失敗した操作のログエントリへのリンク。
401 application/ JSON

認証されたユーザーには、このエンドポイントにアクセスする権限がありません。
応答属性の非表示応答属性の表示オブジェクト
提供された認証情報に一致するユーザーがなかったことを示します。
- エラー string
  
  エラーを説明するメッセージ。
  
  値は invalid session: error finding user for endpoint です。
- error_code string
  
  エラーの種類。
  
  値は InvalidSession です。
- リンク string
  
  失敗した操作のログエントリへのリンク。

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