ドキュメントの一覧表示 (ReadFeed)

特定のコレクションのドキュメント リソース (つまり docs URI パス) に対して GET を実行すると、コレクション以下のドキュメントの一覧が返されます。 ReadFeed を使用すると、すべてのドキュメントを取得したり、コレクション内のドキュメントに 対する増分変更 のみを取得したりできます。

Request

Method	要求 URI	説明
GET	https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs	は、サブスクリプションの下に作成された Azure Cosmos DB アカウントの名前であることに {databaseaccount} 注意してください。 値は {db-id} データベースの ID で、{coll-id} 値はコレクションの名前です。

ヘッダー

すべての Cosmos DB 要求 で使用されるヘッダーについては、「共通の Azure Cosmos DB REST 要求ヘッダー」を参照してください。 ReadFeed Document の重要な応答ヘッダーは次のとおりです。

ヘッダー	必須	Type	説明
x-ms-max-item-count	省略可能	Number	ページごとに返されるアイテムの最大数を示す整数。
x-ms-continuation	省略可能	String	読み取る結果が多い場合は、クエリと読み取りフィード操作に対して返される文字列トークン。 クライアントは、x-ms-continuation 要求ヘッダーをこの値に設定して要求を再送信することで、結果の次のページを取得できます。
x-ms-consistency-level	省略可能	String	これは、オーバーライド後の一貫性レベルです。 有効な値は、 Strong、 Bounded、 Session、または Eventual (最も強いものから弱い順) です。 オーバーライドは、アカウントの構成済みの整合性レベルと同じか弱い必要があります。
x-ms-session-token	省略可能	String	セッション レベルの整合性で使用される文字列トークン。 クライアントは、セッション整合性の読み取り要求中に、このヘッダーの最新の読み取り値をエコーする必要があります。
A-IM	省略可能	String	を に Incremental feed設定するか、それ以外の場合は省略する必要があります。 REST API バージョン 2016-07-11 以降から使用できます。
If-None-Match	省略可能	String	ヘッダーなし: 最初 (コレクション作成時) からのすべての変更を返します "*": コレクションに含まれるデータへのすべての新しい変更を返します <etag>: コレクション ETag に設定すると、その論理タイムスタンプ以降に行われたすべての変更が返されます。 REST API バージョン 2016-07-11 以降から使用できます。
x-ms-documentdb-partitionkeyrangeid	省略可能	String	読み取りデータのパーティション キー範囲の ID です。 REST API バージョン 2016-07-11 以降から使用できます。

本文

なし。

[応答]

コレクション内に格納されているドキュメントの配列を返します。

ヘッダー

すべての Cosmos DB 応答によって返されるヘッダーについては、「 共通の Azure Cosmos DB REST 応答ヘッダー 」を参照してください。 重要な応答ヘッダーは次のとおりです。

ヘッダー	Type	説明
x-ms-continuation	String	操作から追加の結果をフェッチするトークンを返します。 クライアントは、この値を含むヘッダーを使用して要求を x-ms-continuation request 再送信して、実行を再開できます。
x-ms-request-charge	Number	操作によって消費される要求ユニットの数。
etag	String	応答で返された最後のドキュメントの論理シーケンス番号 (LSN)。 増分 ReadDocumentFeed は、If-None-Match でこの値を再送信すると再開できます。

状態コード

次の表に、この操作で返される一般的なステータス コードを示します。 状態コードの完全な一覧については、「 HTTP 状態コード」を参照してください。

HTTP 状態コード	説明
200 OK	操作に成功しました。
400 Bad Request	x-ms-consistency-level に設定されるオーバーライドは、アカウント作成時に設定される値よりも優先されます。 たとえば、整合性レベルが Session の場合、オーバーライドを Strong や Bounded に設定することはできません。

Body

プロパティ	説明
_rid	これはシステムによって生成される、ドキュメントがあるコレクションのリソース ID です。
_count	これは、一覧操作によって返されるドキュメントの数です。
Documents	操作で返されるドキュメントの配列。

ドキュメントのプロパティ

プロパティ	説明
id	これは、ドキュメントを識別する一意の名前です。つまり、同じ idを共有できる 2 つのドキュメントはありません。 は id 255 文字以内にする必要があります。
<custom>	すべてのユーザー定義 JSON。
_rid	これは 、システムによって生成されるプロパティです。 リソース ID (_rid) は、リソース モデル上のリソース スタックごとに階層化された一意識別子です。 ドキュメント リソースの配置と移動のために内部使用されます。
_ts	これは、システムによって生成されるプロパティです。 リソースの最終更新タイムスタンプを示します。 値は、タイムスタンプです。
_self	これは、システムによって生成されるプロパティです。 リソースの一意のアドレス指定が可能な URI です。
_etag	これは、オプティミスティック コンカレンシー制御に必要なリソース etag を指定するシステムによって生成されるプロパティです。
_attachments	これは、添付ファイル リソースのアドレス指定可能なパスを指定する、システムによって生成されるプロパティです。

{  
  "_rid": "d9RzAJRFKgw=",  
  "Documents": [  
    {  
      "id": "SalesOrder1",  
      "ponumber": "PO18009186470",  
      "OrderDate": "2005-07-01T00:00:00",  
      "ShippedDate": "0001-01-01T00:00:00",  
      "AccountNumber": "Account1",  
      "SubTotal": 419.4589,  
      "TaxAmount": 12.5838,  
      "Freight": 472.3108,  
      "TotalDue": 985.018,  
      "Items": [  
        {  
          "OrderQty": 1,  
          "ProductId": 760,  
          "UnitPrice": 419.4589,  
          "LineTotal": 419.4589  
        }  
      ],  
      "_rid": "d9RzAJRFKgwBAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",  
      "_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    },  
    {  
      "id": "SalesOrder2",  
      "ponumber": "PO15428132599",  
      "OrderDate": "2005-07-01T00:00:00",  
      "DueDate": "2005-07-13T00:00:00",  
      "ShippedDate": "2005-07-08T00:00:00",  
      "AccountNumber": "Account2",  
      "SubTotal": 6107.0820,  
      "TaxAmt": 586.1203,  
      "Freight": 183.1626,  
      "TotalDue": 4893.3929,  
      "DiscountAmt": 1982.872,  
      "Items": [  
        {  
          "OrderQty": 3,  
          "ProductCode": "A-123",  
          "ProductName": "Product 1",  
          "CurrencySymbol": "$",  
          "CurrencyCode": "USD",  
          "UnitPrice": 17.1,  
          "LineTotal": 5.7  
        }  
      ],  
      "_rid": "d9RzAJRFKgwCAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwCAAAAAAAAAA==/",  
      "_etag": "\"0000da86-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    }  
  ],  
  "_count": 2  
}  
  

例

GET https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs HTTP/1.1  
x-ms-max-item-count: 10  
x-ms-documentdb-query-enablecrosspartition: False  
x-ms-date: Tue, 29 Mar 2016 02:03:06 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dlmte5%2bJR8gIvDubFWZ0W2cgec22LcFAkZgDZxqOBsOI%3d  
Cache-Control: no-cache  
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0  
x-ms-version: 2015-12-16  
Accept: application/json  
Host: querydemo.documents.azure.com  
Cookie: x-ms-session-token#0=772; x-ms-session-token=772  
  

HTTP/1.1 200 Ok  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Transfer-Encoding: chunked  
Content-Type: application/json  
Content-Location: https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Sun, 27 Mar 2016 22:39:13.369 GMT  
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;  
x-ms-resource-usage: documentSize=0;documentsSize=2;collectionSize=2;  
x-ms-item-count: 2  
x-ms-schemaversion: 1.1  
x-ms-alt-content-path: dbs/testdb/colls/testcoll  
x-ms-content-path: d9RzAJRFKgw=  
x-ms-request-charge: 1  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: 46e2e9a5-4917-4ff6-9be5-6f206c38bb6b  
x-ms-session-token: 0:772  
Set-Cookie: x-ms-session-token#0=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll  
Set-Cookie: x-ms-session-token=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll  
x-ms-gatewayversion: version=1.6.52.5  
Date: Tue, 29 Mar 2016 02:03:07 GMT  
  
{  
  "_rid": "d9RzAJRFKgw=",  
  "Documents": [  
    {  
      "id": "SalesOrder1",  
      "ponumber": "PO18009186470",  
      "OrderDate": "2005-07-01T00:00:00",  
      "ShippedDate": "0001-01-01T00:00:00",  
      "AccountNumber": "Account1",  
      "SubTotal": 419.4589,  
      "TaxAmount": 12.5838,  
      "Freight": 472.3108,  
      "TotalDue": 985.018,  
      "Items": [  
        {  
          "OrderQty": 1,  
          "ProductId": 760,  
          "UnitPrice": 419.4589,  
          "LineTotal": 419.4589  
        }  
      ],  
      "_rid": "d9RzAJRFKgwBAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",  
      "_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    },  
    {  
      "id": "SalesOrder2",  
      "ponumber": "PO15428132599",  
      "OrderDate": "2005-07-01T00:00:00",  
      "DueDate": "2005-07-13T00:00:00",  
      "ShippedDate": "2005-07-08T00:00:00",  
      "AccountNumber": "Account2",  
      "SubTotal": 6107.0820,  
      "TaxAmt": 586.1203,  
      "Freight": 183.1626,  
      "TotalDue": 4893.3929,  
      "DiscountAmt": 1982.872,  
      "Items": [  
        {  
          "OrderQty": 3,  
          "ProductCode": "A-123",  
          "ProductName": "Product 1",  
          "CurrencySymbol": "$",  
          "CurrencyCode": "USD",  
          "UnitPrice": 17.1,  
          "LineTotal": 5.7  
        }  
      ],  
      "_rid": "d9RzAJRFKgwCAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwCAAAAAAAAAA==/",  
      "_etag": "\"0000da86-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    }  
  ],  
  "_count": 2  
}  
  

参照

• Azure Cosmos DB
• Azure Cosmos DB SQL API
• Azure Cosmos DB SQL API SDK
• .NET サンプルからの REST