Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen
MethodEndpointDescription
GET/bi/report/api:listList reports available to the currently signed user.
GET/bi/report/api:list/QUERYList reports available to the currently signed user filtered by the provided search query.
GET/bi/report/api:detail/REPORT_IDShows the detail including views list for selected report specified by REPORT_ID.
GET/bi/report/api:viewDetail/REPORT_VIEW_IDLoads the view detail with data. Not available for images and maps.
GET/bi/report/api:comments/REPORT_IDList comments for the report specified by REPORT_ID.
POST/bi/report/api:addComment/REPORT_ID?text=comments textAdd comment to the report specified by REPORT_ID.
POST/bi/report/api:removeComments/REPORT_ID?id=COMMENT_IDRemove comment COMMENT_ID from the report specified by REPORT_ID.
POST/bi/report/api:editComment/REPORT_ID?id=COMMENT_ID&text=:newtextEdit comment COMMENT_ID from the report specified by REPORT_ID.
GET/POST

/bi/report/api:forceDataTableName/REPORT_ID/DATA_TABLE_NAME

Sets custom table name to load data from different database table.

GET/POST

/bi/report/api:clearcache/REPORT_ID

Deletes report cache
POST/report/api:tableDrilldown/:viewReportId?identifierQuery=:idQueryApplies a drill-down to the table
POST/report/api:tableRollup/:viewReportId?identifierQuery=:idQueryCollapses a drill-down of the table
GET/bi/report/api:getFilterDrilldownAttributeValues/:reportId?filter=:valuesFilter&code=:attributeCode&selectedValues=:alreadySelectedValuesLoads report filters
POST/bi/report/api:setFilter/:reportId?filter=:filterToSetApplies changes to report filter
Info

Special characters in "QUERY" in Endpoint "/bi/report/api:list/QUERY" should be encoded as following: "word1 word2" -> "word1$0020word2".

Listing reports example

Following code will list all reports as JavaScript objects for currently signed user.

Code Block
titleListing reports as objects
$.ajax({
  url: "https://service.belladati.com/bi/report/api:list",
  success: function(reply) { 
	console.log(reply);
  }
});

 

 

Following code will list all report object parameters (description,id,link,name,tags) for all reports of currently signed user.

Code Block
titleListing reports parameters
$.ajax({
	url: "https://service.belladati.com/bi/report/api:list",
	success: function(reply) { 
		for (i = 0; reply.length; i = i + 1) {
            console.log(reply[i].name);
		}
	}
});

 

 

Sv translation
languageja


方法
メソッドエンドポイント説明
GET/bi/report/api:list
現在署名したユーザに利用可能レポートをリストすること
現在サインインされているユーザーが利用できるレポートを一覧表示します。
GET/bi/report/api:list/QUERY
提供された検索クエリによってフィルタリング現在サインユーザに利用可能レポートをリストすること

提供された検索クエリによってフィルタリングされた、現在サインインされているユーザーが利用できるレポートを一覧表示します。

GET/bi/report/api:detail/REPORT_ID

REPORT_ID

で指定され、選択したレポートのビューのリストを含む詳細を表示すること

で指定された選択されたレポートのビューリストを含む詳細を表示します。

GET/bi/report/api:viewDetail/REPORT_VIEW_ID
データを持つビューの詳細をロードします。画像やマップでは使用できないこと

ビューの詳細にデータをロードします。画像や地図にはご利用いただけません。

GET/bi/report/api:comments/REPORT_ID

REPORT_ID

によって指定されたレポートにコメントをリストすること

で指定されたレポートのコメントを一覧表示します。

POST/bi/report/api:addComment/REPORT_ID?text=comments text

REPORT_

IDによって指定されたレポートにコメントを追加すること

IDで指定されたレポートにコメントを追加します。

POST/bi/report/api:removeComments/REPORT_ID?id=COMMENT_ID

REPORT_IDで指定されたレポートからコメントCOMMENT_IDを削除します。

POST/bi/report/api:editComment/REPORT_ID
によって指定されたレポートからCOMMENT_IDコメントを削除すること

レポート例を一覧表示

?id=COMMENT_ID&text=:newtext

REPORT_IDで指定されたレポートからコメントCOMMENT_IDを編集します。

GET/POST

/bi/report/api:forceDataTableName/REPORT_ID/DATA_TABLE_NAME

異なるデータベーステーブルからデータをロードするためのカスタムテーブル名を設定します。

GET/POST

/bi/report/api:clearcache/REPORT_ID

レポートキャッシュを削除します。

POST/report/api:tableDrilldown/:viewReportId?identifierQuery=:idQuery

テーブルにドリルダウンを適用します。

POST/report/api:tableRollup/:viewReportId?identifierQuery=:idQueryテーブルのドリルダウンを折りたたみます。
GET/bi/report/api:getFilterDrilldownAttributeValues/:reportId?filter=:valuesFilter&code=:attributeCode&selectedValues=:alreadySelectedValuesレポートフィルターをロードします。
POST/bi/report/api:setFilter/:reportId?filter=:filterToSetレポートフィルターに変更を適用します。


Info

エンドポイント "/bi/report/api:list/QUERY" の "QUERY" の特殊文字は、"word1 word2" -> "word1$0020word2" のようにエンコードする必要があります。

レポート一覧表示の例

次のコードは、現在サインインしているユーザーのJavaScriptオブジェクトとしてすべてのレポートを一覧表示します。以下のコードは現在サインユーザのJavaScriptオブジェクトなどすべてのレポート一覧を表示されます。

Code Block
titleオブジェクトとしてレポートをリスト
$.ajax({
  url: "https://service.belladati.com/bi/report/api:list",
  success: function(reply) { 
	console.log(reply);
  }
});
 



次のコードは、現在サインインしているユーザーのすべてのレポートの、すべてのレポートオブジェクトパラメーター (description,id,link,name,tags) を一覧表示します。

以下のコードが現在にサインユーザのすべてのレポートのためのすべてのレポートオブジェクトパラメータ(説明、ID、リンク、名前、タグ)一覧を表示されます。

Code Block
titleレポートのパラメータリスト
$.ajax({
	url: "https://service.belladati.com/bi/report/api:list",
	success: function(reply) { 
		for (i = 0; reply.length; i = i + 1) {
            console.log(reply[i].name);
		}
	}
});