1 つのドキュメントの検索

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

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

body

  • dataSource string 必須

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

  • database string 必須

    指定されたデータソース内のデータベースの名前。

  • コレクション string 必須

    指定したデータベース内のコレクションの名前。

  • フィルター オブジェクト

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

  • プロジェクション オブジェクト

    操作によって返された一致したドキュメントのMongoDBプロジェクション。

    プロジェクション属性を非表示 プロジェクション属性の表示 オブジェクト
    • * 数値 additionalProperties

      値は 0 または 1 です。

body

  • dataSource string 必須

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

  • database string 必須

    指定されたデータソース内のデータベースの名前。

  • コレクション string 必須

    指定したデータベース内のコレクションの名前。

  • フィルター オブジェクト

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

  • プロジェクション オブジェクト

    操作によって返された一致したドキュメントのMongoDBプロジェクション。

    プロジェクション属性を非表示 プロジェクション属性の表示 オブジェクト
    • * 数値 additionalProperties

      値は 0 または 1 です。

応答

  • 200

    見つかりました

    応答属性を非表示 応答属性の表示 オブジェクト
    • ドキュメント オブジェクト| null

      指定したフィルターに一致するドキュメント。一致するドキュメントがない場合、これは null です。

    応答属性を非表示 応答属性の表示 オブジェクト
    • ドキュメント オブジェクト| null

      指定したフィルターに一致するドキュメント。一致するドキュメントがない場合、これは null です。
  • 400 application/ JSON

    リクエストの形式が正しくないか、不完全でした。

    次の 1 つ：
    ErrorNoAuthenticationSpecified オブジェクト ErrorMissingAuthenticationParameter オブジェクト
  • 401 application/ JSON

    認証されたユーザーには、このエンドポイントにアクセスする権限がありません。

    応答属性の非表示 応答属性の表示 オブジェクト

    提供された認証情報に一致するユーザーがなかったことを示します。

    • エラー string

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

      値は invalid session: error finding user for endpoint です。

    • error_code string

      エラーの種類。

      値は InvalidSession です。

    • リンク string

      失敗した操作のログエントリへのリンク。
POST /アクション/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"
    }
  }'
リクエストの例 
{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "status": 1
  }
}
リクエストの例 
{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "status": 1
  }
}
応答の例（200） 
{
  "document": {
    "_id": "6193504e1be4ab27791c8133",
    "text": "Do the dishes",
    "status": "open"
  }
}
応答の例（200） 
{
  "document": {
    "_id": {
      "$oid": "6193504e1be4ab27791c8133"
    },
    "text": "Do the dishes",
    "status": "open"
  }
}
応答の例（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"
}