Home

完全な制御を提供する API。

Excel ファイル、バーコード、レポートを生成し、選択した形式に HTML5 データ管理/視覚化コントロールをエクスポートします。これらの強力な Web API を使用して、さまざまなデータソースから Excel ファイルを生成したり、Excel ファイルを操作および結合したり、オンザフライでバーコードを作成したり、膨大なデータセットや SSAS キューブを分析したり、レポートや PDF をレンダリングすることができます。開発者の想像力次第で、その可能性は無限大です。

Excel

インポート/エクスポートサービス

MVC コントロール

Wijmo5 コントロール

Excel ファイルの生成

GET

/api/excel

Generate from dataset\collection

説明

サーバー上に構成されたデータセット/コレクションから Excel ファイルを生成します。

パラメータ一覧

パラメータ 値説明

FileName エクスポートされたファイルの名前。

TemplateFileName テンプレートファイル名。指定しない場合は、自動的にテンプレートを生成します。

Type Excelのファイル形式。

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

要求 URL

JSON データを FlexGrid で表示

XML データの表示

レスポンススキーマ

GET

/api/excel

Generate from XML

説明

ストレージ内にある XML ファイルから Excel ファイルを生成します。

パラメータ一覧

パラメータ 値説明

FileName エクスポートされたファイルの名前。

TemplateFileName テンプレートファイル名（指定しない場合は、生成されたテンプレートを自動的に使用）。

Type Excelのファイル形式。

DataFileName ストレージマネージャーが認識できるxmlデータファイル名。このXMLデータファイルのコンテンツはコレクションに似て、1 つのルート要素がその子要素と同じ複数の要素を持ちます。

<orders>
    <order id="1">
        <price>1000</price>
    </order>
    ......
 </orders>

要求 URL

JSON データを FlexGrid で表示

XML データの表示

レスポンススキーマ

GET

/api/excel

Convert between different formats

説明

ストレージ内にある Excel ファイルを別の形式に変換します。

パラメータ一覧

パラメータ 値説明

FileName エクスポートされたファイルの名前。

Type Excelのファイル形式。

WorkBookFileName ストレージマネージャーが認識できるワークブックファイルファイル名。

要求 URL

JSON データを FlexGrid で表示

XML データの表示

レスポンススキーマ

POST

/api/excel

Generate from XML

説明

クライアントからポストされた XML ファイルから Excel ファイルを生成します。

パラメータ一覧

パラメータ 値説明

FileName エクスポートされたファイルの名前。

TemplateFile テンプレートファイル名。指定しない場合は、自動的にテンプレートを生成します。

Type Excelのファイル形式。

DataFile クライアント側からポストされたXMLデータファイル。このXMLデータファイルのコンテンツはコレクションに似て、1 つのルート要素がその子要素と同じ複数の要素を持ちます。

<orders>
    <order id="1">
        <price>1000</price>
    </order>
    ......
 </orders>

要求 URL

JSON データを FlexGrid で表示

XML データの表示

レスポンススキーマ

POST

/api/excel

Generate from JSON

説明

クライアントからポストされた JSON データから Excel ファイルを生成します。

パラメータ一覧

パラメータ 値説明

FileName エクスポートされたファイルの名前。

TemplateFileName テンプレートファイル名。指定しない場合は、自動的にテンプレートを生成。

Type Excelのファイル形式。

Data クライアント側からポストされるデータコレクション。

要求 URL

JSON データを FlexGrid で表示

XML データの表示

レスポンススキーマ

POST

/api/excel

Convert between different formats

説明

Excel ファイルを別の形式に変換します。

パラメータ一覧

パラメータ 値説明

FileName エクスポートされたファイルの名前。

Type Excelのファイル形式。

WorkbookFile クライアント側からポストされるExcelファイル。使用可能なファイル形式：xls、xlsx、csv。

要求 URL

JSON データを FlexGrid で表示

XML データの表示

レスポンススキーマ

Excel ファイルの結合

GET

/api/excel/merge

説明

ファイルストレージ内にある複数の Excel ファイルを結合します。

パラメータ一覧

パラメータ 値説明

FileName エクスポートされたファイルの名前。

Type Excelのファイル形式。

FileNamesToMerge
ストレージマネージャーが認識できるExcelファイル名。

要求 URL

JSON データを FlexGrid で表示

XML データの表示

レスポンススキーマ

POST

/api/excel/merge

説明

クライアントからポストされた複数のファイルを結合します。

パラメータ一覧

パラメータ 値説明

FileName エクスポートされたファイルの名前。

Type Excelのファイル形式。

FilesToMerge ストレージマネージャーが認識できるExcelファイル名。

要求 URL

JSON データを FlexGrid で表示

XML データの表示

レスポンススキーマ

Excel ファイルの分割

GET

/api/excel/{excel path}/split

説明

ストレージにある 1 つの Excel ファイルを複数の Excel ファイルに分割して、ストレージに保存します。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるワークブックファイル名。

Output Path 出力するストレージ内のパス。指定しない場合は、ソースと同じパスに出力します。

Output Names 出力するファイル名。指定しない場合は、自動的にファイル名が生成されます。

要求 URL

応答データ

ファイルの表示：

レスポンススキーマ

検索/置換

GET

/api/excel/{excel path}/{sheet name}/find

説明

Excel 内のテキストを検索し、すべての一致情報を返します。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるワークブックファイル名。

Sheet Name 検索するシート名。指定しない場合は、すべてのシートを検索します。

検索するテキスト。検索に使用する値。

Match Case 大文字小文字を区別するかどうかを示すブール値。

Whole Cell セル全体を検索するかどうかを示すブール値。

要求 URL

応答データ

レスポンススキーマ

GET

/api/excel/{excel path}/{sheet name}/replace

説明

Excel 内のテキストを置換します。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるExcelファイル名。

Sheet Name 置換するシート名。指定しない場合は、すべてのシートを置換。

Text 置換されるテキスト。

New Text 置き換える新しいテキスト。

Match Case 大文字小文字を区別するかどうかを示すブール値。

セル全体セル全体を検索するかどうかを示すブール値。

要求 URL

応答データ

ファイルの表示：

レスポンススキーマ

行

POST

/api/excel/{excel path}/{sheet name}/rows/{row index}

説明

行を追加します。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるワークブックファイル名。

Sheet Name シート名。

Row Indexes 追加する行のインデックス。

Count 追加する行数。

要求 URL

応答データ

ファイルの表示：

レスポンススキーマ

PUT

/api/excel/{excel path}/{sheet name}/rows/{row indexes}

説明

行を更新します。この API を使用して、行を非表示/非表示およびグループ/グループ解除できます。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるワークブックファイル名。

Sheet Name シート名。

Row Indexes 更新する行インデックス。書式：{num}; {num},{num},...; {num}-{num}。例：1,3-5

プロパティ名更新する行のプロパティ名。使用可能なプロパティは"Visible(bool)"と"OutlineLevel(int)"です。

プロパティ値更新する行のプロパティの値。

要求 URL

応答データ

ファイルの表示：

レスポンススキーマ

DELETE

/api/excel/{excel path}/{sheet name}/rows/{row indexes}

説明

行を削除します。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるワークブックファイル名。

Sheet Name シート名。

Row Indexes 行インデックス。書式：{num}; {num},{num},...; {num}-{num}。例：1,3-5

要求 URL

応答データ

ファイルの表示：

レスポンススキーマ

列

POST

/api/excel/{excel path}/{sheet name}/columns/{column index}

説明

列を追加します。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるワークブックファイル名。

Sheet Name シート名。

Column Index 追加する列インデックス。

Count 追加する列数。

要求 URL

応答データ

ファイルの表示：

レスポンススキーマ

PUT

/api/excel/{excel path}/{sheet name}/columns/{column indexes}

説明

列を更新します。この API を使用して、列を非表示/非表示およびグループ/グループ解除できます。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるワークブックファイル名。

Sheet Name シート名。

Column Indexes 列インデックス一覧。書式：{num}; {num},{num},...; {num}-{num}。例：1,3-5

Property Name 更新する列のプロパティ名。使用可能なプロパティは Visible(bool) と OutlineLevel(int)です。

Property Value 更新する列のプロパティ値。

要求 URL

応答データ

ファイルの表示：

レスポンススキーマ

DELETE

/api/excel/{excel path}/{sheet name}/columns/{column indexes}

説明

列を削除します。

パラメータ一覧

パラメータ 値説明

Excel Path ストレージマネージャーが認識できるワークブックファイル名。

Sheet Name シート名。

Column Indexes 列インデックス一覧。書式：{num}; {num},{num},...; {num}-{num}。例：1,3-5

要求 URL

応答データ

ファイルの表示：

レスポンススキーマ

Storage

FileManager sample

FileManager Control

ファイル管理

POST

/api/storage/{path}

説明

ファイルをストレージにアップロードします。

パラメータ一覧

パラメータ 値説明

path

ストレージ内のファイルパス。 DropBox : DropBox/C1WebApi/test.xlsx
ステップ1：DropBoxアカウントにログインします。
ステップ2：アプリを作成し、このアプリのアクセストークンを生成します。
ステップ3：ステップ2で作成したアクセストークンを使用して、Web.configのDropBoxStorageAccessTockenキー値に配置します。
ステップ4：WebApiExplorerプロジェクトを開き、Storage apiセクションに移動します。
ステップ5： "C1WebApi"をあなたのアプリの名前に変更します。
ステップ6： "test.xlsx"をポストしたいファイル名に変更します。
注：List Apiを使用している場合は、 "test1"をサブフォルダーのパスに変更する必要があります。
詳細については、サンプル〜\ WebApi \ Samples \ CSを参照してください。

file アップロードするファイル。デモの場合は、.xlsxファイルを選択してください

要求 URL

応答データ

View Files:

レスポンススキーマ

DELETE

/api/storage/{path}

説明

ファイルをストレージから削除します。

パラメータ一覧

パラメータ 値説明

path

要求 URL

応答データ

レスポンススキーマ

GET

/api/storage/List/{path}

説明

ターゲットフォルダからすべてのファイル、フォルダを一覧表示します。

パラメータ一覧

パラメータ 値説明

path

DropBox : DropBox/C1WebApi/test.xlsx
ステップ1：DropBoxアカウントにログインします。
ステップ2：アプリを作成し、このアプリのアクセストークンを生成します。
ステップ3：ステップ2で作成したアクセストークンを使用して、Web.configのDropBoxStorageAccessTockenキー値に配置します。
ステップ4：WebApiExplorerプロジェクトを開き、Storage apiセクションに移動します。
ステップ5： "C1WebApi"をあなたのアプリの名前に変更します。
ステップ6： "test.xlsx"をポストしたいファイル名に変更します。
注：List Apiを使用している場合は、 "test1"をサブフォルダーのパスに変更する必要があります。
詳細については、サンプル〜\ WebApi \ Samples \ CSを参照してください。

要求 URL

応答データ

レスポンススキーマ

Report

レポートリスト

GET

/api/report/{folder path}

説明

指定されたフォルダパス内のレポートリストを取得します。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

再帰的パス以下のすべてのレポートを取得するかどうかを示す boolean 値。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains the ICatalogItem object which describes the folder or report.

404 The folder path or report path does not exist.

レポート

GET

/api/report/{folder path}/{report name}/$report

説明

指定されたレポートの情報を取得します。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IReportInfo type object.

404 The report path does not exist.

GET

/api/report/{folder path}/{report name}/$report/pagesettings

説明

指定されたレポートで定義されているデフォルトのページ設定を取得します。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IPageSettings type object.

404 The report path does not exist.

GET

/api/report/{folder path}/{report name}/$report/parameters

説明

レポートで定義されているすべてのパラメータを取得します。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of IParameter.

404 The report path does not exist.

GET

/api/report/{folder path}/{report name}/$report/parameters/{parameter name}

説明

レポート内で定義されている指定のパラメータを取得します。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

パラメータ名パラメータ名。例：pCategory

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IParameter type object.

404 The report path or parameter name does not exist.

GET

/api/report/{folder path}/{report name}/$report/supportedformats

説明

サポートされているすべてのエクスポート形式を取得します。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of IExportDescription.

404 The report path does not exist.

GET

/api/report/{folder path}/{report name}/$report/supportedformats/{supported format}

説明

サポートされている指定の形式を取得します。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

サポートされている形式名サポートされている形式名。例：HTML

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IExportDescription type object.

404 The report path or format name does not exist.

GET

/api/report/{folder path}/{report name}/$report/export

説明

オプション、指定されたページ設定/パラメータなどを使用して、指定されたエクスポートフィルタにレポートをレンダリングおよびエクスポートします。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

形式サポートされている形式。supportedformats アクションの応答を参照してください。

エクスポートファイル名エクスポートされるファイルの名前。

レポートパラメータ例として、FlexCommonTasks.flxr/MultiValue DataBound Parameters レポートを使用できます。
レポートパラメータ。parameters アクションの応答を参照してください。例：
parameters.pCategory=1&...

パラメータが複数値の場合は、その回数だけパラメータを設定します。例：
parameters.pCategory=1&parameters.pCustomers=3&...

エクスポートオプションエクスポートオプション。supportedformats アクションの応答を参照してください。例：
exportOptions.outputRange=1&...

レポートページ設定ページ設定は次のように行います。pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm

Headers

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 The exported file stream.

404 The report path or format name does not exist.

406 The format name is not acceptable.

POST

/api/report/{folder path}/{report name}/$report/export

説明

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

形式サポートされている形式。supportedformats アクションの応答を参照してください。

エクスポートファイル名エクスポートされるファイルの名前。

エクスポートオプションエクスポートオプション。supportedformats アクションの応答を参照してください。例：
exportOptions.outputRange=1&...

レポートページ設定ページ設定は次のように行います。pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm

ヘッダー

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 The exported file stream.

404 The report path or format name does not exist.

406 The format name is not acceptable.

レポートインスタンス

POST

/api/report/{folder path}/{report name}/$instances

説明

指定されたレポートから新しいレポートインスタンスを作成します。

パラメータ

パラメータ 値説明

フォルダパスレポートプロバイダマネージャーが認識できるフォルダパス。

レポート名 FlexReport ファイルまたは SSRS フォルダの下に定義されているレポート名。

レポートページ設定ページ設定は次のように行います。pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

201 Json string contains IReportInstanceInfo type object, for the new created instance.

404 The report path does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}

説明

指定されたインスタンス ID を持つレポートインスタンスの情報を取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

キャッシュ ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IReportInstanceInfo type object.

404 The report path or instance id does not exist.

POST

/api/report/{folder path}/{report name}/$instances/{instance id}/render

説明

指定されたインスタンス ID を持つレポートインスタンスをレンダリングします。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのキャッシュ ID。

レポートページ設定ページ設定は次のように行います。pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm

アクション文字列アクション文字列。これは SSRS レポート専用です。例として、AdventureWorks (SSRS)/Product Line Sales レポートを使用できます。例：
actionString=77u%2FPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48TFQgcmVmPSIxIiB0eXBlPSJMVCI%2BPERBIHR5cGU9IlNTUlNTQSI%2BPFNJRD4zM2lUMDwvU0lEPjxEPkFzY2VuZGluZzwvRD48L0RBPjwvTFQ%2B

ヘッダー

応答データ

応答メッセージ

HTTP ステータスコード 理由

200 (Render completed.) Json string contains IReportStatus type object.

202 (On Rendering.) The render action is accepted.

404 The report path or instance id does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/status

説明

指定されたインスタンス ID を持つレポートインスタンスのステータスを取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのキャッシュ ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IReportStatus type object.

404 The report path or instance id does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

説明

指定されたインスタンス ID を持つレポートインスタンス内のパラメータを取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。
例として、FlexCommonTasks.flxr/MultiValue DataBound Parameters レポートを使用できます。

インスタンス ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of IParameter.

404 The report path or instance id does not exist.

PUT

/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

説明

指定されたインスタンス ID を持つレポートインスタンス内のすべてのパラメータ値を更新します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。
例として、FlexCommonTasks.flxr/MultiValue DataBound Parameters レポートを使用できます。

インスタンス ID 実行するレポートのインスタンス ID。

レポートパラメータレポートパラメータ。parameters アクションの応答を参照してください。例：
pCategory=1&...

パラメータが複数値の場合は、その回数だけパラメータを設定します。例：
pCategory=1&pCustomers=3&...

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of IParameter which are the new parameters with validation.

404 The report path or instance id does not exist.

PATCH

/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

説明

指定されたインスタンス ID を持つレポートインスタンス内の指定されたパラメータ値を更新します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。
例として、FlexCommonTasks.flxr/MultiValue DataBound Parameters レポートを使用できます。

インスタンス ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of IParameter which are the new parameters with validation.

404 The report path or instance id does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName}

説明

指定されたインスタンス ID を持つレポートインスタンス内の指定された名前のパラメータを取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。
例として、FlexCommonTasks.flxr/MultiValue DataBound Parameters レポートを使用できます。

インスタンス ID 実行するレポートのインスタンス ID。

パラメータ名パラメータ名。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IParameter type object.

404 The report path or instance id does not exist.

PUT

/api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName}

説明

指定されたインスタンス ID を持つレポートインスタンス内の指定された名前のパラメータの値を更新します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。例として、FlexCommonTasks.flxr/MultiValue DataBound Parameters レポートを使用できます。

インスタンス ID 実行するレポートのインスタンス ID。

パラメータ名パラメータ名。

パラメータ値レポートパラメータ値。例：
value=1&...

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IParameter type object which is the new parameter with validation.

404 The report path or instance id or parameter name does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings

説明

指定されたインスタンス ID を持つレポートインスタンス内の現在のページ設定を取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IPageSettings type object.

404 The report path or instance id does not exist.

PUT

/api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings

説明

指定されたインスタンス ID を持つレポートインスタンス内のすべてのページ設定プロパティを更新します。

PageSettings

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

レポートページ設定ページ設定は次のように行います。paperSize=custom&height=10in&width=20.5cm

Headers

Response Data

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IPageSettings type object which is the new page settings. Use the default value if one property is not set.

404 The report path or instance id does not exist.

PATCH

/api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings

説明

指定されたインスタンス ID を持つレポートインスタンス内の指定されたページ設定プロパティを更新します。

PageSettings

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

レポートページ設定ページ設定は次のように行います。paperSize=custom&height=10in&width=20.5cm

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IPageSettings type object which is the new page settings.

404 The report path or instance id does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/supportedformats

説明

サポートされているすべてのエクスポート形式を取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of IExportDescription.

404 The report path or instance id does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/supportedformats/{format name}

説明

指定されたインスタンス ID を持つレポートインスタンスによってサポートされる、指定された名前のエクスポート形式を取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

サポートされている形式名サポートされている形式名。例：HTML

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IExportDescription type object.

404 The report path or instance id or format name does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/features

説明

指定されたインスタンス ID を持つレポートインスタンスによってサポートされる機能を取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IDocumentFeatures type object.

404 The report path or instance id does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/export

説明

オプションを使用して、指定されたインスタンス ID を持つレポートインスタンスをレポートフィルタにエクスポートします。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

形式サポートされている形式。supportedformats アクションの応答を参照してください。

エクスポートファイル名エクスポートされるファイルの名前。

エクスポートオプションエクスポートオプション。supportedformats アクションの応答を参照してください。例：
outputRange=1&...

ヘッダー

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 The exported file stream.

404 The report path or instance id does not exist or the request page range is not rendered. (The report is not render completed.)

406 The format name is not acceptable.

POST

/api/report/{folder path}/{report name}/$instances/{instance id}/export

説明

オプションを使用して、指定されたインスタンス ID を持つレポートインスタンスをレポートフィルタにエクスポートします。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

形式サポートされている形式。supportedformats アクションの応答を参照してください。

エクスポートファイル名エクスポートされるファイルの名前。

エクスポートオプションエクスポートオプション。supportedformats アクションの応答を参照してください。例：
outputRange=1&...

ヘッダー

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 The exported file stream.

404 The report path or instance id does not exist or the request page range is not rendered. (The report is not render completed.)

406 The format name is not acceptable.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/outlines

説明

指定されたインスタンス ID を持つレポートインスタンス内のすべてのアウトラインを取得します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains collection of IOutlineNode type objects.

404 The report path or instance id does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/bookmarks/{bookmark name}

説明

指定されたインスタンス ID を持つレポートインスタンス内の指定された名前のブックマークを取得します。

パラメータ

（最初にレポートをロードしてください。）

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。
例として、FlexCommonTasks.flxr/Report Navigation レポートを使用できます。

インスタンス ID 実行するレポートのインスタンス ID。

ブックマーク名ブックマーク名。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IDocumentPosition type object.

404 The report path or instance id or bookmark id does not exist.

GET

/api/report/{folder path}/{report name}/$instances/{instance id}/search

説明

指定されたインスタンス ID を持つレポートの検索結果を取得します。レポートがレンダリング済みであることを確認してください。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。
例として、FlexCommonTasks.flxr/Simple List レポートを使用できます。

インスタンス ID 実行するレポートのインスタンス ID。

開始ページインデックス検索する最初のページの 0 ベースのインデックス。

検索範囲検索の範囲。

検索テキスト検索に使用する値。

大文字小文字の区別大文字小文字を区別して値を検索するかどうかを示す Boolean 値。

単語単位単語単位で値を検索するかどうかを示す Boolean 値。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of ISearchResult type objects.

404 The report path or instance id does not exist.

POST

/api/report/{folder path}/{report name}/$instances/{instance id}/stop

説明

現在のレンダリングを停止します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

インスタンス ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IReportStatus type object.

404 The report path or instance id does not exist.

DELETE

/api/report/{folder path}/{report name}/$instances/{instance id}

説明

インスタンスを削除します。

パラメータ

パラメータ 値説明

レポートの完全パス実行するレポートの完全パス。

キャッシュ ID 実行するレポートのインスタンス ID。

ヘッダー

応答データ

応答メッセージ

HTTP ステータスコード 理由

204 Succeed to delete the instance.

404 The report path or instance id does not exist.

Barcode

バーコードの生成

GET

/api/barcode

説明

バーコードを生成する API

パラメータ

基本設定

パラメータ 値説明

Type バーコード画像のファイルタイプ。

Text バーコード画像としてエンコードされる値。

CodeType バーコード画像の生成時に使用するエンコーディングのタイプ。

BackColor バーコード画像の背景色を取得または設定します。

ForeColor バーコード画像の前景色を取得または設定します。

CaptionPosition バーコードシンボルに対するバーコードキャプションの相対的な位置。

CaptionAlignment バーコードに対するバーコードキャプションの相対的な配置。

CheckSumEnabled 適切な場合にバーコードのチェックサムを計算してバーコードに含めるかどうかを示す値を取得または設定します。

QRCode の設定

Model QRCode のモデルを取得または設定します。

ErrorLevel バーコードのエラー修正レベルを取得または設定します。

Version QRCode のバージョンを取得または設定します。Model プロパティが Model1 に設定されている場合は 1 ～ 14 の値を、Model2 の場合は 1 ～ 40 の値を指定してください。-1 が指定された場合は、この値に最適なバージョンが自動的に決定されます。

Mask バーコードのマスクに使用されるパターンを取得または設定します。

ConnectionNumber バーコードの連結番号を取得または設定します。

Connection バーコードに連結を使用するかどうかを取得または設定します。

PDF417 の設定

Column バーコードの列番号を取得または設定します。

Row バーコードの行番号を取得または設定します。

ErrorLevel バーコードのエラー修正レベルを取得または設定します。

Type PDF417 バーコードのタイプを取得または設定します。

Code49 の設定

Group グループ番号を取得または設定します。

Grouping バーコードにグループが設定されるかどうかを示す値を取得または設定します。

RssExpandedStacked の設定

RowCount スタックする行の数を取得または設定します。

MicroPDF417 の設定

CompactionMode CompactionMode を取得または設定します。

FileID 構造的連接シンボルのファイル ID を取得または設定します。

SegmentCount 構造的連接シンボルのセグメント数を取得または設定します。

SegmentIndex 構造的連接シンボルのセグメントインデックスを取得または設定します。

Version シンボルのバージョンを取得または設定します。

Code25intlv の設定

LineStroke ベアラバーの色。

BearBar ITF バーコードにベアラバーを表示するかどうか。

LineStrokeThickness ベアラバーの線幅。

GS1Composite の設定

Type 合成シンボルタイプを取得または設定します。

Value CCA または CCB 文字データを取得または設定します。

Ean128Fnc1 の設定

BarAdjust ドット単位の調整サイズを取得または設定します。

Dpi プリンタの解像度を取得または設定します。

ModuleSize バーコードモジュールの水平方向のサイズを取得または設定します。

DataMatrix の設定

EccMode ECC モードを取得または設定します。

Ecc200SymbolSize ECC200 シンボルのサイズを取得または設定します。

Ecc200EncodingMode ECC200 エンコーディングモードを取得または設定します。

Ecc000_140SymbolSize ECC000-140 シンボルのサイズを取得または設定します。

StructureNumber 構造的連接シンボル内の現在のシンボルの構造番号を取得または設定します。

StructuredAppend 現在のシンボルが構造的連接シンボルの一部かどうかを示す値を取得または設定します。

FileIdentifier 関連する構造的連接シンボルグループのファイル識別子を取得または設定します。

要求 URL

バーコード

DataEngine

サービスのサンプル

MVC コントロール

Wijmo5 コントロール

サービス

GET

/api/dataengine/{datasource}/fields

説明

データ内のすべてのフィールドを取得します。

パラメータ一覧

パラメータ 値説明

Data Source フィールド情報を取得するためのデータソース。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 A field array is returned.

404 {datasource} is invalid.

GET

/api/dataengine/{datasource}?[skip=n&top=m]

説明

生データを取得します。キューブデータとの接続時にはサポートされません。

パラメータ一覧

パラメータ 値説明

Data Source 分析するデータソース。

Skip 生データ全体の開始インデックスを指定する正の整数値。設定しない場合は、最初のエントリから返します。

Top 返却する生データの数を指定する正の整数値。設定しない場合は、スキップ値から始まるすべてのエントリを返します。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 An IRawData object is returned to specify the aggregated result information. It includes two items: an array for the aggregated data and a number value for the total count of all the raw data without paging.

404 {datasource} is invalid.

POST

/api/dataengine/{datasource}

説明

出力テーブル内の特定のセルのコンテンツを定義する生データソース内のオブジェクトのリストを取得します。キューブデータとの接続時にはサポートされません。

パラメータ一覧

パラメータ 値説明

Data Source 分析するデータソース。

Skip 詳細エントリ全体の開始インデックスを指定する正の整数値。設定しない場合は、最初のエントリから返します。

Top 返される詳細エントリの数を指定する正の整数値。設定しない場合は、スキップ値から始まるすべてのエントリを返します。

ビュー定義分析するビュー定義。例：
{
fields:[
   {"binding":"Active","dataType":3},
   {"binding":"Country","dataType":1},
   {"binding":"Date","dataType":4},
   {"binding":"Discount","dataType":2},
   {"binding":"Downloads","dataType":2},
   {"binding":"ID","dataType":2},
   {"binding":"Product","dataType":1},
   {"binding":"Sales","dataType":2}
],
rowFields:{items:["Product"]},
columnFields:{items:["Country"]},
valueFields:{items:["Sales"]}
}

Key 対応する値を介してセルを指定します。これは配列オブジェクトです。最初に、rowFields 内のフィールドの値を順にキーに追加する必要があります。次に、columnFields 内のフィールドの値を順に追加します。null のフィールド値がある場合は、そのまま null を配列に追加します。null を削除してはなりません。キー配列の数を rowFields および columnFields 内のフィールドの数と同じにする必要があります。
例：
["Aoba", "China"]

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 An IRawData object is returned to specify the detail result information. It includes two parts: an array for the raw data of the cell and the total count of the raw data without paging.

404 {datasource} is invalid.

POST

/api/dataengine/{datasource}/fields/{fieldname}/uniquevalues

説明

フィールドの一意の値を取得します。キューブデータとの接続時にはサポートされません。

パラメータ一覧

パラメータ 値説明

Data Source 分析するデータソース。

Field 一意の値を取得するフィールド。
例：
Product

ビュー定義分析するビュー定義。次に例を示します：
{
fields:[
   {"binding":"Active","dataType":3},
   {"binding":"Country","dataType":1},
   {"binding":"Date","dataType":4},
   {"binding":"Discount","dataType":2},
   {"binding":"Downloads","dataType":2},
   {"binding":"ID","dataType":2},
   {"binding":"Product","dataType":1},
   {"binding":"Sales","dataType":2}
],
rowFields:{items:["Product"]},
columnFields:{items:["Country"]},
valueFields:{items:["Sales"]}
}

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 An array is returned to specify the unique values of a field.

404 {datasource} or {fieldname} is invalid.

POST

/api/dataengine/{datasource}/analyses

説明

指定されたデータソースのデータを分析します。

パラメータ一覧

パラメータ 値説明

Data Source 分析するデータソース。

ビュー定義分析するビュー定義。次に例を示します。
{
fields:[
   {"binding":"Active","dataType":3},
   {"binding":"Country","dataType":1},
   {"binding":"Date","dataType":4},
   {"binding":"Discount","dataType":2},
   {"binding":"Downloads","dataType":2},
   {"binding":"ID","dataType":2},
   {"binding":"Product","dataType":1},
   {"binding":"Sales","dataType":2}
],
rowFields:{items:["Product"]},
columnFields:{items:["Country"]},
valueFields:{items:["Sales"]}
}

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

201 An IAnalysis object is returned to specify the analysis result information. It includes the status and the result data. If executingStatus in the status is “Completed”, the result data is an array which stands for the aggregated result data. Otherwise, the result data is always null. Location in response header shows the url to access the analysis instance.

404 {datasource} is invalid.

GET

/api/dataengine/{datasource}/analyses/{token}/status

説明

分析のステータスを取得します。

パラメータ一覧

パラメータ 値説明

Data Source 分析するデータソース。

Token 分析インスタンスのトークン。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 An IStatus object is returned to specify the status. If the status is still “Executing”, you can send this request repeatedly until the status is changed to other values: Completed, Cleared or Exception. When it is “Completed”, it means the query has been executed successfully and the data is prepared. You can get the data by the 7th service: Get: /host/{datasourcekey}/analyses/{token}/result. If the status is “Exception”, it means some error occurs during the executing. For example, the token provided in this request doesn’t exist, an exception would be returned as response.

404 {datasource} or {token} is invalid.

GET

/api/dataengine/{datasource}/analyses/{token}/result

説明

分析結果データを取得します。

パラメータ一覧

パラメータ 値説明

Data Source 分析するデータソース。

Token 分析インスタンスのトークン。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 An array object is returned to specify the result data. After calling this service to obtain the data prepared, the token will be removed. You cannot use it in other requests then. Otherwise, an exception would be returned.

404 {datasource} or {token} is invalid.

GET

/api/dataengine/{datasource}/analyses/{token}

説明

分析情報を取得します。

パラメータ一覧

パラメータ 値説明

Data Source 分析するデータソース。

Token 分析インスタンスのトークン。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 An IAnalysis object is returned to specify the analysis result information.

404 {datasource} or {token} is invalid.

DELETE

/api/dataengine/{datasource}/analyses/{token}

説明

分析をクリアします。

パラメータ一覧

パラメータ 値説明

Data Source 分析するデータソース。

Token 分析インスタンスのトークン。

ヘッダー

応答データ

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

204 No content for response.

404 {datasource} or {token} is invalid.

Visitor

Samples for Visitor API

Visitor API

Pdf

PDF

GET

/api/pdf/{pdf path}/$pdf

説明

指定された PDF の実行情報を取得します。

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Headers

Response Data

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IExecutionInfo type object.

404 The pdf path does not exist.

GET

/api/pdf/{pdf path}/$pdf/status

説明

指定された PDF のステータスを取得します。

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Headers

Response Data

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IDocumentStatus type object.

404 The pdf path does not exist.

GET

/api/pdf/{pdf path}/$pdf/supportedformats

説明

サポートされているすべてのエクスポート形式を取得します。

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Headers

Response Data

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of IExportDescription.

404 The pdf path does not exist.

GET

/api/pdf/{pdf path}/$pdf/features

説明

サポートされているすべての機能を取得します。

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Headers

Response Data

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains IDocumentFeatures type object.

404 The pdf path does not exist.

GET

/api/pdf/{pdf path}/$pdf/export

説明

指定された形式とオプションで PDF をエクスポートします。

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Format The supported formats, please see the response of SupportedFormats action.

Export Options The export options, please see the response of SupportedFormats action. E.g:
outputRange=1&...

Headers

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 The exported file stream.

404 The pdf path does not exist.

406 The format name is not acceptable.

POST

/api/pdf/{pdf path}/$pdf/export

説明

ボディに指定された形式とオプションで PDF をエクスポートします。

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Format The supported formats, please see the response of SupportedFormats action.

Export Options The export options, please see the response of SupportedFormats action. E.g:
outputRange=1&...

Headers

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 The exported file stream.

404 The pdf path does not exist.

406 The format name is not acceptable.

GET

/api/pdf/{pdf path}/$pdf/search

説明

指定されたパスの PDF ドキュメントソースインスタンス内の検索結果を取得します。

Parameters

Parameter Value Description

Pdf Path The pdf file that storage manager can recognize.

Start Page Index 0-based index of the first page to search.

Search Scope The search scope.

Search Text The value which is used to search.

Match Case A boolean value indicates if search the value with case sensitive.

Whole Word A boolean value indicates if search the value with matching a whole word.

Headers

Response Data

レスポンススキーマ

応答メッセージ

HTTP ステータスコード 理由

200 Json string contains a collection of ISearchResult type objects.

404 The pdf path does not exist.