Management Portal APIを使用したレポートのエクスポート

作成日	更新日	影響を受けるバージョン	修正バージョン
19 Jun 2023	14 Feb 2024	Management Portal	N/A

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

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

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

	エンドポイント	メソッド	リクエストフォーマット	説明
単一のレポートのエクスポート	/report/export/{uuid}	GET	N/A	単一のレポートをそのUUIDでエクスポートします。
レポートのエクスポート (GET)	/report/export?@imei={imei}	GET	N/A	オプションのIMEIフィルターを使用して、過去1か月のレポートをエクスポートします。
レポートのエクスポート (POST)	/report/export	POST	application/json	リクエスト本文 (body) で指定されたフィルタ/オプションを使用してレポートをエクスポートします。

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

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

次の例では、{UUID}を有効なレポートUUIDに、{API_KEY}をAPIキーのキー文字列に置き換えてください。まだAPIキーをお持ちでない場合は、APIキーの記事を参照してください。

curlのリクエスト例

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

デフォルトでは、レポートはXML形式でエクスポートされます。PDFとJSONもサポートされており、UUIDの後にリクエストURLの一部として "?format="パラメータを指定することで形式を変更することができます。formatパラメータでサポートされている値は、XML、JSON、PDFです。

PDF形式のcurlリクエスト例

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)

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

次の例では、{IMEI}をデバイスの有効なIMEIに、{API_KEY}をAPIキーのキー文字列に置き換えます。まだAPIキーをお持ちでない場合は、APIキーの記事を参照してください。

curlのリクエスト例

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)

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

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

フィールド名	XMLフィールドパス	名前
IMEI	blancco_hardware_report.system.imei	@imei
System Serial	blancco_hardware_report.system.serial	@system_serial
Erasure State	blancco_erasure_report.erasures.erasure.state	@erasure_state
Custom field	user_data.fields.{CUSTOM_FIELD_NAME}	@custom-{CUSTOM_FIELD_NAME}

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

追加パラメータ

パラメータ

説明

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レポートをすべて含む１つのXMLファイルが返されます。containerが"ZIP"の場合、返されたZIPファイル内にはすべての個別のファイルが含まれます。

JSON ペイロードの例

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

CSVエクスポート用JSONペイロードの例

{
    "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キーの記事を参照してください。

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