ASP.NET Web API コントロール
Excelサービスの生成
サービス > Excelサービス > Excelサービスの生成

指定されたXML、JSON、およびデータソースファイルから、RESTベースのAPIで瞬時にExcelファイルを生成します。さらに、REST APIサービスを利用することにより、各種のワークブック形式の間で簡単に変換できます。リモートストレージまたはローカルストレージからデータを取得するか、またはクライアントからデータをアップロードしてExcelファイルを生成し、Excel形式の間で変換します。

クライアントアプリケーションは、HTTP要求をWeb APIサービスアプリケーションに送ります。この要求は、GETメソッドとPOSTメソッドを使用してサービスからの応答を検索します。GETメソッドは指定されたリソースから目的の情報を取得し、POSTメソッドはリソースにデータを送信します。

Excel要求スキーマの生成

ストレージ(ローカルまたはリモート)内に存在するデータから適切な形式でExcelワークブックを生成するには、GETメソッドを使用する必要があります。この場合は、要求URL内で保存場所、および生成されるExcelのファイル形式を指定します。
GET: http://[:port]/api/excel?FileName=<>&type=<>&datafilename=<>

XMLからExcelを生成するためのGET要求スキーマ

次の図は、ストレージに存在するXMLデータファイルから、目的の形式でExcelを生成するためのための要求URLパラメータを示しています。

次の表は、要求URLパラメータ(ストレージ内のXMLからExcelを生成するためのパラメータ)とそれらのサポートされる値を示しています。

パラメータ

サポートされた値

説明

FileName

String

生成されたExcelファイルの名前は、ユーザによって指定されます。

Type

json, xlsx, xls, csv, xml

生成されたExcelファイルの形式。

DataFileName

ストレージマネージャが認識するデータファイル名。

ストレージ内のXMLデータファイル。

データセット/コレクションからExcelを生成するためのGET要求スキーマ

次の図は、ストレージに存在するデータセット/コレクションから、目的の形式でExcelを生成するためのための要求URLパラメータを示しています。

次の表は、要求URLパラメータ(ストレージ内のデータセット/コレクションからExcelを生成するためのパラメータ)とそれらのサポートされる値を示しています。

パラメータ

説明

FileName

String

生成されたExcelファイルの名前は、ユーザによって指定されます。

Type

json, xlsx, xls, csv, xml

生成されたExcelファイルの形式。

DataName

データプロバイダが認識するデータ名。

ストレージ内のデータセット/データコレクション。

Excel形式を変換するためのGET要求スキーマ

次の図は、ストレージに存在するExcel形式のファイルを目的の形式で変換するための要求URLパラメータを示しています。

次の表は、要求URLパラメータ(ストレージ内のExcelファイルを希望の形式に変換するためのパラメータ)とそれらのサポートされる値を示しています。

パラメータ

サポートされた値

説明

FileName

String

生成されたExcelファイルの名前は、ユーザによって指定されます。

Type

json, xlsx, xls, csv, xml

変換されたExcelファイルの形式。

WorkBookFileName

ストレージマネージャが認識しているExcelファイル名。

ストレージ内の(変換されるための)Excelファイル。

クライアントからポストされたXMLからExcelを生成するためのPOST要求スキーマ

データがストレージに存在せず、クライアントから提供される場合には、POSTメソッドを使用する必要があります。この場合、クエリー文字列のパラメータは、URLではなくPOST要求のHTTPメッセージ本文に含まれて送信されます。POSTの要求URLは次のように表示されます。

POST: http://[:port]/api/excel

データがストレージに存在せず、クライアントから提供される場合は、POSTメソッドを使用します。

次の表は、要求URLパラメータ(クライアントからポストされたXMLからExcelを生成するためのパラメータ)とそれらのサポートされる値を示しています。

パラメータ

説明

FileName

String

生成されたExcelファイルの名前は、ユーザによって指定されます。

Type

json, xlsx, xls, csv, xml

生成されたExcelファイルの形式。

DataFile

xml

クライントからアップロードするためのXMLデータのコンテキストはコレクションのようです(ルート要素の同じに複数の子要素を持つ要素。)

クライアントからポストされたJSONデータからExcelを生成するためのPOST要求スキーマ

次の表は、要求URLパラメータ(クライアントからポストされたJSONからExcelを生成するためのパラメータ)とそれらのサポートされる値を示しています。

パラメータ

説明

FileName

String

生成されたExcelファイルの名前は、ユーザによって指定されます。

Type

json, xlsx, xls, csv, xml

生成されたExcelファイルの形式。

Data

json

ライアントからアップロードする必要があるJSONデータ。

Excel形式のファイルを変換するためのPOST要求スキーマ

次の表は、要求URLパラメータ(クライアントからポストされたExcelを希望の形式に変換するためのパラメータ)とそれらのサポートされる値を示しています。

パラメータ

説明

FileName

String

生成されたExcelファイルの名前は、ユーザによって指定されます。

Type

json, xlsx, xls, csv, xml

変換されたExcelファイルの形式。

WorkBookFileName

xls, xlsx, csv

ライアントからアップロードする必要がある変換されたExcelファイル。

ここでは、ユーザーが要求URL内のクエリパラメータを指定する必要はありません。(クライアントからポストされたXMLからExcelを生成, クライアントからポストされたJSONデータからExcelを生成, and クライアントからポストされたデータを使用してワークブック形式を変換t)のトピックでは、パラメータまたはクエリー文字列をPOST要求のHTTPメッセージ本文に含まれて送信される方法を具体的に説明します。

関連トピック