嵌入式报表REST体系结构

Question

当您希望使用Bluemix嵌入式报表时，首先创建包，然后创建报表定义。在此之后，人们应该在这里使用Swagger记录的REST API：

https://erservice-impl.ng.bluemix.net/ers/swagger-ui/

不幸的是，我无法找到这些API的任何架构定义。为了详细说明这个概念，有一些API来获取连接、包、定义、报告、模型、数据源和可视化。但是，我找不到任何描述我何时使用什么的文档。此外，一些基本的API，比如那些与"reports“的操作有关的API，似乎想要一个"reportId”，而我对如何检索或获取其中的API感到迷茫。其他的谜团是“什么是报告链接”的概念？获取“报表实例”的语义是什么？一份“以格式呈现”的报告..。什么是允许的格式，什么时候我会使用与另一个？

再一次..。REST并不坏，Swagger提供了有用的语法文档，但是没有相关的语义理解，它给读者留下了如何使用该技术的空白。

我希望有更多的文件，要么在某个地方存在，要么计划尽快发布。如果有人知道在哪里找到这些信息，或者有更多关于如何解释API语义的信息，这将是对这个问题的一个很好的回答。

Answer 1

关于REST的一些信息，特别是关于运行报表的信息，可以在服务的文档页面上找到，在这里可以找到：https://console.ng.bluemix.net/docs/services/EmbeddableReporting/index.html#gettingstartedtemplate。

虽然完整的API是在swagger中提供的，但用户只需要使用3种资源：connection、definitions和reports。其他端点处理报表工件及其相关资源(数据源、模型、包)的管理。

使用ERS的第一步是在管理仪表板中定义数据源和报告规范(定义)。然后，将为每个定义提供一个ID，您可以将其复制/粘贴到RESTful调用中。

1. 使用basic和/connection端点连接到ERS。这会发送回cookies (包括一个JSESSIONID)，期望您与所有其他调用一起发送这些cookie。 POST /connection

具有空的json主体{}和基本auth标头。

1. 以特定格式运行报告(2种口味) 2.1对于没有特殊选项或参数的“vanilla”报告，可以使用快捷调用，它既创建报表资源，又以您选择的格式运行它： 获取/定义/{definition_id}/报告/{格式} 其中definition_id是从管理仪表板上提取的，格式是html中的一种，phtml (部分html，用于嵌入)。)，pdf，json，xml，csv 2.2对于更复杂的情况，您需要首先创建一个报表实例(对于正在运行的报表来说，这个状态保持不变)。您可以执行下一页或检查参数值和选项)。然后可以以一种格式运行报表。 员额/定义/{definition_id}/reports 有你的选择和参数的身体。还可以为所有默认值发送空的json主体({})。这将返回具有reportId和要运行报表的位置的json负载。 获取/报告/{report_id}/{格式}

您还可能需要查看文档中包含的示例( javascript、java和节点)，以了解如何在应用程序中实现这一点。上面提到的文档也有卷曲的例子。