このドキュメントでは、BellaDati REST APIで利用可能なすべてのオブジェクトと方法を示します。
ユーザー
リソース | URL | 方法 | 概要 |
|---|---|---|---|
| GET ユーザ名でユーザの詳細情報 | /api/users/username/:username | GET | ユーザ名により指定されたユーザーに関する詳細をロードします。 |
/api/users/:id | GET | IDにより指定されたユーザーに関する詳細をロードします。 | |
/api/users/:id/status | GET | IDにより指定したユーザのアクティブステータスを返却します。 | |
/api/users/:id/image | GET | IDにより指定されたユーザーの画像を返却します | |
/api/users/create | POST | 新規ユーザー作成 | |
/api/users/:id | POST | IDにより指定したユーザーを変更します。 | |
| POST ユーザステータスの設定 | /api/users/:id/status | POST | IDにより指定したユーザーをアクティブ/非アクティブにします。 |
| POST ユーザーグループの作成 | /api/users/groups/create | POST | 新規ユーザーグループ作成 |
| POST ユーザリクエストの作成 | /api/users/:username/requests | POST | ユーザ名により指定されたユーザーの新ユーザー要求を作成します。 |
| POST アクセストークンの作成 | /api/users/:username/accessToken | POST | ユーザ名により指定されたユーザーの新アクセストークンを作成します。 |
ドメイン
リソース | URL | 方法 | 概要 |
|---|---|---|---|
/api/domains | GET | ドメイン一覧 | |
| GET ドメインの詳細 | /api/domains/:id | GET | IDによって指定されたドメインの詳細を返却します。 |
| GET ユーザ | /api/domains/:domain_id/users | GET | ドメインIDにより指定されたドメイン用ユーザー一覧を表示します |
| GET ユーザグループ | /api/domains/:domain_id/userGroups | GET | ドメインIDにより指定したドメインのユーザーグループ一覧を表示します |
/api/domains/create | POST | 新規ドメイン作成 | |
/api/domains/:id | POST | IDにより指定されたドメインを変更します。 | |
| POST サインパラメーター | /api/domains/:domain_id/signParameters | POST | 合格したパラメータの署名を取得します |
| POST サインリソース | /api/domains/:domain_id/signResource | POST | 必要なリソースの署名を取得します。 |
データセット
リソース | URL | 方法 | 概要 |
|---|---|---|---|
/api/dataSets | GET | ユーザに利用可能なすべてのデータセット一覧を表示します。 | |
/api/dataSets/:id | GET | 指定されたIDでデータセットの詳細情報を表示する。 | |
| GET 属性値 | /api/dataSets/:id/attributes/:code/values | GET | 指定されたデータセットと値コードによる属性コード属性一覧を表示します。 |
| POST 属性値の画像 | /api/dataSets/:id/attributes/:code/:value/image | POST | 与えられたデータセットIDコードの属性と属性値に外観設定で画像を編集します。 |
| GET Data Sources | /api/dataSets/:id/dataSources | GET | 指定されたIDを持つデータセットに関するすべてのデータソース一覧を表示します。 |
/api/dataSets/dataSources/:id/executions | GET | データソースIDにより指定されたすべてのデータソースのアクション一覧を表示します。 | |
/api/dataSets/dataSources/:id/schedule | POST | IDにより指定したデータソース用スケジュールを立てます。 | |
| GET Data Set Data | /api/dataSets/:id/data | GET | IDで指定された目的のデータセットのデータセットデータを取得します。 |
レポート
リソース | URL | 方法 | 概要 |
|---|---|---|---|
/api/reports | GET | ユーザに有効になった全レポートのリスト | |
| GET ユーザー名によるレポート | /api/reports/username/:username | GET | ユーザへの利用可能なすべてのレポート一覧を表示します。 |
/api/reports/:id | GET | 指定されたIDを持つレポートの詳細情報を表示します。 | |
/api/reports/:id/thumbnail | GET | PNGフォーマットでレポートのサムネイル画像を返却します。 | |
/api/reports/:id/comments | GET | 指定されたIDを持つレポートのすべてのコメントを返却します。 | |
/api/reports/:id/comments | POST | 指定されたIDを持つレポートへコメントを投稿します。 | |
| DELETE コメント | /api/reports/comments/:id | DELETE | IDによって指定されたコメントを削除します。 |
/api/reports/:id/filter/attributeValues | GET | 提供属性コードのための属性値を返却します。 | |
| /api/reports/:id/images | POST | 指定されたIDを持つレポートに画像を投稿します。 |
ビュー
リソース | URL | 方法 | 概要 |
|---|---|---|---|
/api/reports/views/:id/chart | GET | この方法は、チャートのメタデータを返却します。（HTML5レンダラ用） | |
/api/reports/views/:id/kpi | GET | この方法は、データと特定のKPIビューのメタデータを返却します。 | |
/api/reports/views/:id/text | GET | この方法は、カスタムコンテンツとそのメタデータを返却します。 | |
/api/reports/views/:id/table/bounds | GET | この方法は、テーブルの枠を返却します。。 | |
/api/reports/views/:id/table/leftHeader | GET | このメソッドはHTMLのフォームで左ヘッダーを返却します。。 | |
/api/reports/views/:id/table/topHeader | GET | この方法は、HTMLのフォームでトップヘッダを返却します。 | |
/api/reports/views/:id/table/data | GET | この方法は、HTMLフォームでテーブルデータを返却します。 | |
/api/reports/views/:id/table/json | GET | この方法は、JSONフォーマットでテーブル全体を返却します。。 | |
| GET マップ | /api/reports/views/:id/map | GET | この方法は、JSONフォーマットでマップをレンダリングするためのデータを返却します。。 |
| /api/reports/views/:id/image | GET | この方法は、PNGフォーマットの画像としてビュー（チャートまたはテーブル）を返却します。 | |
| GET PDFとして表示 | /api/reports/views/:id/export/pdf | GET | この方法は、PDFファイルとしてビュー（チャート、テーブルやマップ）を返却します。。 |
| POST 画像ビューの編集 | /api/reports/views/:id/image | POST | この方法は、指定されたIDを持つビューで画像を編集します。 |
ダッシュボード
Resource | URL | Method | Overview |
|---|---|---|---|
/api/dashboards | GET | この方法は、ユーザーに利用可能なすべてのダッシュボードのリストを実行します。 | |
| GET ユーザー名ごとのダッシュボード | /api/dashboards/username/:username | GET | 指定したユーザに有効になったダッシュボードリスト |
/api/dashboards/:id | GET | この方法は、idパラメータによって指定された詳細ダッシュボードのロードを実行します。 | |
/api/dashboards/:id/thumbnail | GET | この方法は、PNGフォーマットの最初のビューによって表示されるダッシュボードのサムネイルを返却します。。 |
インポート
Resource | URL | Method | Overview |
|---|---|---|---|
/api/import/forms | GET | この方法は、反映されたユーザー用収集フォームのデータリストを返却します。 | |
/api/import/forms/:id | POST | この方法はIDで指定したデータフォーマットを投稿します。 | |
| POST JSON Data | /api/import/:id | POST | この方法はJSONフォーマットでBellaDatiにデータを投稿します。 |
| POST メディアギャラリーに画像 | /api/import/media/image | POST | BellaDatiメディアギャラリーに画像を投稿します。 |
ユーティリティ
Resource | URL | Method | Overview |
|---|---|---|---|
/api/utils/file/{path} | GET | 指定された絶対パスからファイルを返却します。 | |
| GET PDFファイルをマージする | /api/utils/mergePdfFiles/{paths} | GET | 1つのPDFファイルにPDFファイルをマージします。（";"で指定した絶対パスで指定された） |
Overview
Content Tools