Page History

This page will cover basics on how to utilize Management Portal APIs when exporting reports from the system.

More detailed examples and full descriptions for all available endpoint and their respective parameters can be found from API Guide available within the "Support"-tab in Management Portal.

Below table describes currently available report export endpoints and their differences on a higher level and allows user to choose the best option for the requirements.

この記事では、システムからレポートをエクスポートする際に、Management Portal APIを使用する基本的な方法について説明します。

利用可能なすべてのエンドポイントと対応する各パラメータに関する詳細な例と説明は、Management Portalの「サポート」タブ内にあるAPIガイドを参照してください。

次の表は、現在利用可能なレポートエクスポートのエンドポイントとその違いを上位のレベルで説明し、要件に最適なオプションを選択できるようにしたものです。

Export reportsExport reports Export reports

	エンドポイント	メソッド	リクエストフォーマット	1つのリクエストで複数レポートがエクスポート可能	レポートのフィルター機能が利用可能	説明
単一のレポートのエクスポート	Endpoint	Method	Request Format	Allows exporting reports for multiple devices in a single request	Allows filtering for reports	Description		/report/export/{uuid}	GET	N/A			Export a single report with its UUID.	単一のレポートをそのUUIDでエクスポートします。
レポートのエクスポート	(GET)	/report/export?@imei={imei}	GET	N/A			Export past month's reports with optional IMEI filtering.	オプションのIMEIフィルターを使用して、過去1か月のレポートをエクスポートします。
レポートのエクスポート (POST)	/report/export	POST	application/json			Export reports with more advanced filters/options provided in the request body.

Export Report

The most simple form of exporting an individual report, requires the report UUID to be provided as part of the endpoint.

単一のレポートのエクスポート

個々のレポートをエクスポートする最もシンプルな形式を使用する場合、エンドポイントの中にレポートUUIDを指定する必要があります。

次の例では、{UUID}を有効なレポートUUIDに、{API_KEY}をAPIキーのキー文字列に置き換えてください。まだAPIキーをお持ちでない場合は、APIキーの記事を参照してください。In the following examples replace {UUID} with a valid report UUID and {API_KEY} with the key string of your API key. If you don't have an API key yet, see more details from API Keys documentation.

curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

By default the report is exported in XML format. Also PDF and JSON are supported, the format can be changed by defining デフォルトでは、レポートはXML形式でエクスポートされます。PDFとJSONもサポートされており、UUIDの後にリクエストURLの一部として "?format=" parameter as part of the request URL after the UUID. Supported values for the format parameter are XML, JSON and PDF.パラメータを指定することで形式を変更することができます。formatパラメータでサポートされている値は、XML、JSON、PDFです。 

curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}?format=PDF" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

...

レポートのエクスポート (GET)

Export past month's reports with optional IMEI filtering. If the report is not created during the past month it will not be included in the results.

オプションのIMEIフィルターを使用して、過去1か月のレポートをエクスポートします。過去1ヶ月の間にレポートが作成されていない場合、レポートは結果に含まれません。

次の例では、{IMEI}をデバイスの有効なIMEIに、In the following examples replace {IMEI} with a valid device IMEI and {API_KEY} with the key string of your API key. If you don't have an API key yet, see more details from API Keys documentation.をAPIキーのキー文字列に置き換えます。まだAPIキーをお持ちでない場合は、APIキーの記事を参照してください。

curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export?@imei={IMEI}" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

...

レポートのエクスポート (POST)

Export reports with the options provided in the request body. Allows user to define more defined search criteria and only return matching reports.

Supported report fields

リクエスト本文で指定されたオプションを使用してレポートをエクスポートします。より明確な検索条件を指定して、一致するレポートのみを返すことができます。

サポートされるレポートのフィールド

Additionally multiple other parameters can be defined to further limit the returned results and the output format.

Additional parameters

他にも複数のパラメータを指定して返される結果を絞り込み、出力形式を指定することもできます。

追加パラメータ

{
  "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"
}

Example Request

This example request would export XML format reports for IMEI 123456789012345 created after 1st of January 2023. The exported reports will be returned in a zip folder (each report in its own separate file).

{
    "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 123456789012345と{API_KEY}をそれぞれ有効なIMEIとAPIキーのキー文字列に置き換えて利用してください。まだAPIキーをお持ちでない場合は、APIキーの記事を参照してください。In the following example replace IMEI with a valid IMEI and {API_KEY} with the key string of your API key. If you don't have an API key yet, see more details from API Keys documentation.

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"
}'

...