ドキュメントのサンプルを調べる & 検証する

POST /groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents
tokenAuth

コレクション内のドキュメントのサブセットをクエリし、それぞれの一致をスキーマと照合して検証します。

path パラメータ

application/ JSON

body 必須

  • database_name string 必須

    検証するコレクションを含むデータベースの名前。

  • collection_name string 必須

    検証するコレクションの名前。

  • from_schema オブジェクト 必須

    サンプル ドキュメントを検証するための EJSON スキーマ。

  • クエリ オブジェクト

    コレクション内のドキュメントに一致するMongoDB クエリ。このクエリを実行した結果がサンプル母集団です。これを使用して、サンプルをコレクション内のドキュメントのサブセットに絞り込みます。

    デフォルト値は {}（空）です。

  • limit 数値

    サンプルするドキュメントの最大数。

    デフォルト値は10000です。

  • sort オブジェクト

    コレクションの MongoDB ソート。これを使用して、範囲クエリのどの端からサンプリングを開始するかを決定します。

    デフォルト値は {}（空）です。

応答

POST /groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents 
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"database_name":"string","collection_name":"string","from_schema":{},"query":{},"limit":10000,"sort":{}}'
リクエスト例 
{
  "database_name": "string",
  "collection_name": "string",
  "from_schema": {},
  "query": {},
  "limit": 10000,
  "sort": {}
}
応答の例（200） 
{
  "errors": [
    {
      "error_code": "false",
      "error_count": 42.0,
      "field": "(root)._id",
      "failed_ids": [
        "string"
      ],
      "failed_documents_query": {}
    }
  ],
  "total_processed_count": 42.0,
  "total_error_count": 42.0
}