作成日 | 更新日 | 影響を受けるバージョン | 修正バージョン |
---|---|---|---|
|
| Management Portal | N/A |
Table of Contents |
---|
この記事では、システムからレポートをエクスポートする際に、Management Portal APIを使用する基本的な方法について説明します。
利用可能なすべてのエンドポイントと対応する各パラメーターに関する詳細な例と説明は、Management 利用可能なすべてのエンドポイントと対応する各パラメータに関する詳細な例と説明は、Management Portalの「サポート」タブ内にあるAPIガイドを参照してください。
...
エンドポイント | メソッド | リクエストフォーマット | 1つのリクエストで複数レポートがエクスポート可能 | レポートのフィルター機能が利用可能 | 説明 | Export reports|
---|---|---|---|---|---|---|
単一のレポートのエクスポート | /report/export/{uuid} | GET | N/A | ![]() | ![]() | 単一のレポートをそのUUIDでエクスポートします。 Export reports |
レポートのエクスポート (GET) | /report/export?@imei={imei} | GET | N/A | ![]() | ![]() | オプションのIMEIフィルターを使用して、過去1か月のレポートをエクスポートします。 Export reports |
レポートのエクスポート (POST) | /report/export | POST | application/json | ![]() | ![]() | リクエスト本文 (body) で指定されたフィルタ/オプションを使用してレポートをエクスポートします。 |
...
単一のレポートのエクスポート
個々のレポートをエクスポートする最もシンプルな形式を使用する場合、エンドポイントの中にレポートUUIDを指定する必要があります。
次の例では、{UUID}を有効なレポートUUIDに、{API_KEY}をAPIキーのキー文字列に置き換えてください。まだAPIキーをお持ちでない場合は、API Keys APIキーの記事を参照してください。
Code Block | ||
---|---|---|
| ||
curl -X "GET" \ "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}" \ -H "accept: */*" \ -H "X-BLANCCO-API-KEY: {API_KEY}" |
...
次の例では、{IMEI}をデバイスの有効なIMEIに、{API_KEY}をAPIキーのキー文字列に置き換えます。まだAPIキーをお持ちでない場合は、API Keys APIキーの記事を参照してください。
Code Block | ||
---|---|---|
| ||
curl -X "GET" \ "https://api.eu-west-1.blancco.cloud/v1/report/export?@imei={IMEI}" \ -H "accept: */*" \ -H "X-BLANCCO-API-KEY: {API_KEY}" |
...
パラメータ | 説明 |
---|---|
date | エクスポートするレポートの日付範囲。このオブジェクトは、次の有効な名前を持つプロパティで構成されます:lte (less than or equal, 以下)、lt (less than, 未満)、eq (equal, 等しい) 、gt (greater than, 以上超過) 、gte (greater than or equal, 以上) 。 定義されていない場合、デフォルトでは過去1か月のレポートがエクスポートされます。 例えば、2021年1月のすべてのレポートをエクスポートするには、次のように指定します: {"gte". "2021-01-01T00:00:00Z", "lt": "2021-02-01T00:00:00Z"}. dateのフィルター機能を無効にするには、空のオブジェクトを使用します。過去1ヶ月のデフォルトの範囲は、月の 「数値」を減らすことで導き出されます。例えば、エクスポートが実行時の現在の日時が2021-03-01T07:00:00Zであれば、それが日付範囲の終了日時になり、開始は2021-02-01T07:00:00Zになります。 |
format | エクスポートされるレポートの形式。省略した場合、消去レポートのデフォルトの形式は"XML"です。 有効な値:"CSV"、"JSON"、および"XML" |
container | すべての個別レポートが含まれるコンテナの形式。 有効な値: "NONE "および "ZIP"(デフォルト)。 "NONE"を指定すると、レポートはレポート自体と同じ形式の単一のファイルにまとめられます。例えば、formatが"XML"でcontainerが"NONE"の場合、個々のXMLレポートをすべて含む1つのXMLファイルが返されます。containerが"ZIP"の場合、返されたZIPファイル内にはすべての個別のファイルが含まれます。 |
Code Block | ||
---|---|---|
| ||
{
"filter": {
"date": {
"gte": "2023-01-01T00:00:00Z"
},
"fields": [
{
"name": "@imei",
"like": "{IMEI}"
},
{
"name": "@custom-my custom field",
"like": "{CUSTOM_FIELD_VALUE}"
}
]
},
"format": "XML",
"container": "ZIP"
} |
Code Block | ||
---|---|---|
| ||
{ "filter": { "date":{ }, "fields": [ { "name": "@erasure_state", "like": "Successful" } ] }, "csv":{ "columns": ["blancco_erasure_report.erasures.erasure.timestamp","blancco_erasure_report.erasures.erasure.state","blancco_hardware_report.system.manufacturer","blancco_hardware_report.system.model"] }, "format": "CSV", "container": "NONE" } |
リクエストの例
このリクエスト例では、2023年1月1日以降に作成されたIMEI 123456789012345のXML形式のレポートをエクスポートします。エクスポートされたレポートはzipフォルダで返されます (各レポートは個別ファイル) (各レポートは個別ファイル) 。
次の例では、IMEIを有効なIMEIに、例の中のIMEI 123456789012345と{API_KEY}をAPIキーのキー文字列に置き換えます。まだAPIキーをお持ちでない場合は、API Keysをそれぞれ有効なIMEIとAPIキーのキー文字列に置き換えて利用してください。まだAPIキーをお持ちでない場合は、APIキーの記事を参照してください。
Code Block |
---|
curl -X 'POST' \ 'https://api.eu-west-1.blancco.cloud/v1/report/export' \ -H 'accept: */*' \ -H 'X-BLANCCO-API-KEY: {API_KEY}' \ -H 'Content-Type: application/json' \ -d '{ "filter": { "date": { "gte": "2023-01-01T00:00:00Z" }, "fields": [ { "name": "@imei", "like": "123456789012345" }, { "name": "@custom-my custom field", "like": "my custom field value" } ] }, "format": "XML", "container": "ZIP" }' |
...