データを CSV へエクスポート

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

ASoC API は通常、応答データを JSON 形式で提供します。これは、データをプログラムで処理する場合に便利です。ただし、データをスプレッドシート (Excel など) にインポートする場合は、データを ASoC から CSV ファイルにエクスポートすることをお勧めします。

応答形式は、クライアントが要求で送信する「Accept」HTTP ヘッダーによって決まります。デフォルトでは、Accept ヘッダーが指定されていない場合、応答形式は JSON になります。応答を CSV 形式で取得するには、以下のヘッダーを要求に追加する必要があります。

Accept: text/csv

ASoC API は、応答で提供されるデータをフィルタリングおよび選択する際に OData V4 を使用することに注意してください。これは CSV 形式の応答にも適用されます。

API の使用

API を使用するには有効なアクセス・トークンが必要ですが、アクセス・トークンを取得するには、アカウントに関連付けられた API キーが必要です。詳細については、API 鍵の生成を参照してください。

Swagger

データを CSV 形式で取得するには、「実行」ボタンをクリックする前に、デフォルトの「応答コンテンツ・タイプ」を「application/json」から「text/csv」に変更します。

詳しくは、Swagger の資料を参照してください。

curl

以下に示すのは、アカウントからアクセスできるすべてのアプリケーションのすべてのプロパティーを返す curl コマンドの例です (<access token> には有効なアクセス・トークンを指定してください)。

curl -X GET --header 'Accept: text/csv' --header 'Authorization: Bearer <access token>'
                    'https://cloud.appscan.com/api/v4/Apps'

API は OData をサポートしているため、$filter および $select 要求パラメーターを使用して、データの一部を取得できます。以下の例では、リスク等級の高いアプリケーションだけが取得され、各アプリケーションには「ID」、「名前」、および「リスク等級」の 3 つのプロパティーが含まれています。

curl -X GET --header 'Accept: text/csv' --header 'Authorization: Bearer <access token>'
                    'https://cloud.appscan.com/api/v4/Apps?
                    $filter=RiskRating%20eq%20'\''High'\''&$select=Id%2CName%2CRiskRating'

以下も参照してください。

CSV 形式