CSV 形式

このセクションでは、応答データを CSV 形式で保存する方法について説明します。

階層

CSV 形式は階層をサポートしないので、階層を持つモデルを表す場合、CSV のプロパティー名は各階層レベルを区切るドット (.) で連結されます。

JSON 表記:
[
  { 
    "Name": "Scan1",
    "LastSuccessfulExecution": {
      "CreatedAt": "2021-04-18T07:13:58Z",
      "Status": "Ready",
    }
  },
  {
    "Name": "Scan2",
    "LastSuccessfulExecution": {
      "CreatedAt": "2021-04-17T20:53:40.33Z",
      "Status": "Ready",
    }
  }
]
同等の CSV 表記:
Name,LastSuccessfulExecution.CreatedAt,LastSuccessfulExecution.Status,
Scan1,2021-04-18 07:13:58,Ready
Scan2,2021-04-17 20:53:40,Ready

配列

配列プロパティーは現在サポートされていません。応答形式が CSV で、返されるモデルに「配列」タイプのプロパティーが含まれている場合、このプロパティーは省略されます。

日付と時刻

CSV 応答の日時は、常に UTC で表記されます。

プロパティーの順序

  • 応答にすべてのプロパティーが含まれているが、$select パラメーターが含まれていない場合、プロパティーの順序はサンプルの JSON 応答 (Swagger の関連する関数内) のようになります。
  • $select パラメーターを使用して選択されたプロパティー (列) のみが応答に含まれている場合、CSV 内の列の順序は、$select パラメーターで指定されているプロパティーの順序に従います。
  • (要求で $expand パラメーターを使用したことによって) 応答に展開されたプロパティーが含まれている場合、展開されたプロパティーを含む列は常に他の列の前に表示されます。

エンコード中

CSV 応答本文のエンコード方式は UTF-8 で、応答の先頭に BOM が付いています。

このエンコード方式により、応答が .CSV 拡張子のファイルに保存されている場合、Excel から応答を開けるとともに、Unicode 文字がサポートされます。

サイズが大きいデータ・セット

単一の API 呼び出しによって返される項目の数は 30,000 に制限されています。

要求されたデータがこの制限を超えると、最初の 30,000 項目だけが返されます。

必要なデータが制限を超える場合は、最大 10,000 項目の要求を複数回行うことで取得できます。

これは、要求パラメーターの $top および $skip を使用して行います。

$top では、取得する項目の数を指定します。これは 10,000 項目に制限されています。

$skip では、スキップする項目の数を指定します。

例えば、データ・セットに 45,000 項目が含まれており、そのすべてが必要な場合は、以下の 5 つの要求を使用できます。
$top=10000&$skip=
$top=10000&$skip=10000
$top=10000&$skip=20000
$top=10000&$skip=30000
$top=10000&$skip=40000

最後の要求では 5,000 項目だけが返され、取得する項目がこれ以上ないことが示されます。