MongoDB Atlas Data API (v1)

OpenAPI 仕様をダウンロード: ダウンロード

MongoDB Atlas でデータを読み取り、書込み、集計するためのフルマネージド API。データ API はサーバーレス Atlas Functions によって強化され、ユーザー認証とロールベースの権限で保護されています。データ API の詳細については、「API Atlas Data APIを参照してください。

Data API のセットアップ

Data API を使用する前に、Atlas App Services App で有効にして構成する必要があります。構成は、アプリのユーザーが認証、リクエストを認可し、 API と対話する方法を制御します。

アプリでデータ API の使用を開始する方法については、「データ API を設定する」を参照してください。

リクエストの認証

App Services の Data API 構成は、ユーザーが API リクエストを認証する方法を制御します。ほとんどの場合は、ユーザーがアプリの認証プロバイダのいずれかを使用してログインできるアプリケーション認証を使用します。ユーザーは、すべてのリクエストでログイン認証情報を直接提供するか、認証されたセッション用に再利用可能なアクセストークンを提供できます。

詳細については、「データ API リクエストの認証」を参照してください。

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

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

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
フィルター必須	オブジェクトドキュメントに一致する MongoDB クエリフィルター。データ API がサポートするすべてのクエリ演算子のリストについては、「クエリ演算子」を参照してください。
	オブジェクト操作によって返された一致したドキュメントのMongoDB プロジェクション。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"text": "Do the dishes"
},
"projection": {"status": 1,
"text": 1
}
}

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

{"document": {"_id": "6193504e1be4ab27791c8133",
"status": "open",
"text": "Do the dishes"
}
}

ドキュメントの検索

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

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
フィルター必須	オブジェクトドキュメントに一致する MongoDB クエリフィルター。データ API がサポートするすべてのクエリ演算子のリストについては、「クエリ演算子」を参照してください。
	オブジェクト操作によって返された一致したドキュメントのMongoDB プロジェクション。
sort	オブジェクトソートされたフィールド名と方向を示すMongoDB ソート式。
limit	数値応答に含める一致するドキュメントの最大数。
スキップ	数値応答から省略する一致するドキュメントの数。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

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

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

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

1つのドキュメントの挿入

コレクションに 1 つのドキュメントを挿入します。

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
ドキュメント必須	オブジェクトコレクションに挿入するドキュメント。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"document": {"status": "open${{ env.BUNDLED_SPEC_FILEPATH }}",
"text": "Do the dishes"
}
}

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

{"insertedId": "6193504e1be4ab27791c8133"
}

ドキュメントの挿入

コレクションに複数のドキュメントを挿入します。

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
ドキュメント必須	の配列オブジェクトコレクションに挿入するドキュメントのリスト。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"documents": [{"status": "open",
"text": "Mop the floor"
},
{"status": "open",
"text": "Clean the windows"
}
]
}

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

{"insertedIds": ["61935189ec53247016a623c9",
"61935189ec53247016a623ca"
]
}

1 つのドキュメントの更新

コレクション内の 1 つのドキュメントを更新します。

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
フィルター必須	オブジェクトドキュメントに一致する MongoDB クエリフィルター。データ API がサポートするすべてのクエリ演算子のリストについては、「クエリ演算子」を参照してください。
update 必須	オブジェクト一致するドキュメントに適用する MongoDB 更新式。データ API がサポートするすべての更新演算子のリストについては、「更新演算子」を参照してください。
upsert	ブール値デフォルト: false `true`の場合、アップデートフィルターが既存のドキュメントと一致しない場合は、フィルターと指定されたアップデート操作に基づいて新しいドキュメントを挿入します。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"_id": {"$oid": "642f1bb5cee4111898828bf6"
}
},
"update": {"$set": {"status": "complete"
}
},
"upsert": false
}

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

{"matchedCount": 1,
"modifiedCount": 1
}

Update Documents

コレクション内の複数のドキュメントを更新します。

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
フィルター必須	オブジェクトドキュメントに一致する MongoDB クエリフィルター。データ API がサポートするすべてのクエリ演算子のリストについては、「クエリ演算子」を参照してください。
update 必須	オブジェクト一致するドキュメントに適用する MongoDB 更新式。データ API がサポートするすべての更新演算子のリストについては、「更新演算子」を参照してください。
upsert	ブール値デフォルト: false `true`の場合、アップデートフィルターが既存のドキュメントと一致しない場合は、フィルターと指定されたアップデート操作に基づいて新しいドキュメントを挿入します。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"status": "open"
},
"update": {"$set": {"status": "complete"
}
}
}

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

{"matchedCount": 12,
"modifiedCount": 12
}

単一ドキュメントの削除

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

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
フィルター	オブジェクトドキュメントに一致する MongoDB クエリフィルター。データ API がサポートするすべてのクエリ演算子のリストについては、「クエリ演算子」を参照してください。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"text": "Do the dishes"
}
}

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

{"deletedCount": 1
}

Delete Documents

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

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
フィルター	オブジェクトドキュメントに一致する MongoDB クエリフィルター。データ API がサポートするすべてのクエリ演算子のリストについては、「クエリ演算子」を参照してください。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"status": "complete"
}
}

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

{"deletedCount": 12
}

ドキュメントの集計

集計パイプラインを実行します。

認可:

AccessToken（メールパスワード） apiKeyカスタム JWT

リクエストボディスキーマ：
application/ JSON

dataSource 必須	string リンクされた MongoDB Atlas データソースの名前。これは通常`"mongodb-atlas"`ですが、データソースの作成時に別の名前を選択した場合、アプリでは異なる場合があります。
database 必須	string 指定されたデータソース内のデータベースの名前。
コレクション必須	string 指定したデータベース内のコレクションの名前。
パイプライン必須	の配列オブジェクト集計ステージの配列。

応答

リクエストサンプル

ペイロード
cURL

コンテンツタイプ

application/ JSON

[{"$groupBy": {"_id": "$status",
"count": {"$sum": 1
},
"tasks": {"$push": "$text"
}
}
},
{"$sort": {"count": 1
}
}
]

応答サンプル

200
400
401

コンテンツタイプ

application/ JSON

[{"$groupBy": {"_id": "$status",
"count": {"$sum": 1
},
"tasks": {"$push": "$text"
}
}
},
{"$sort": {"count": 1
}
}
]

MongoDB Atlas Data API (v1)

Data API のセットアップ

リクエストの認証

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

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

ドキュメントの検索

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

1つのドキュメントの挿入

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

ドキュメントの挿入

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

1 つのドキュメントの更新

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

Update Documents

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

単一ドキュメントの削除

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

Delete Documents

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

ドキュメントの集計

認可:

リクエスト ボディ スキーマ： application/ JSONapplication/ EJSONapplication/ JSON

応答

リクエスト サンプル

応答サンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル

リクエストボディスキーマ：
application/ JSON

リクエストサンプル