Bluemix Embedded Reports REST架构

时间:2016-02-20 04:08:37

标签: rest ibm-cloud cognos

当人们希望使用Bluemix嵌入式报告时,首先要创建一个包,然后创建一个报告定义。之后,应该使用在此使用Swagger记录的REST API:

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

不幸的是,我无法找到这些API的任何架构定义。要详细说明这个概念,有一些API可以获得连接,包,定义,报告,模型,数据源和可视化......但是我找不到任何文档来描述何时使用它。此外,还有一些基本的API,例如那些与"报告"的操作有关的API。似乎想要一个" reportId"我迷失在如何检索或获得其中之一。其他谜团是"什么是报告链接的概念?"什么是获取"报告实例"的语义?对于报告"以格式"呈现...允许的格式是什么?我何时使用vs另一种格式?

再一次...... REST API并不坏,Swagger提供了有用的语法文档,但没有相关的语义理解,让读者对如何使用该技术感到冷淡。

我希望在某个地方存在其他文件,或者在可行的情况下尽快计划发布。如果有人知道在哪里找到这样的或者有关于如何解释API语义的其他信息,那么这将是一个很好的答案。

1 个答案:

答案 0 :(得分:1)

有关REST API的一些信息,特别是有关报告运行的信息,请参见此处的服务文档页面:https://console.ng.bluemix.net/docs/services/EmbeddableReporting/index.html#gettingstartedtemplate

尽管swagger提供了完整的API,但用户只需使用3种资源:连接定义报告。其他端点处理报告工件及其相关资源(数据源,模型,包)的管理

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

  1. 使用基本身份验证和/连接端点连接到ERS。这将发回您希望与所有其他呼叫一起发送的cookie(包括JSESSIONID)。

    POST /connection 
    
  2. 使用空的json body {}和基本的auth标头

    1. 以特定格式(2种口味)运行报告

      2.1对于'香草'如果没有特殊选项或参数的报告,您可以使用快捷方式调用,它会创建报告资源并以您选择的格式运行它:

      GET /definitions/{definition_id}/reports/{format}
      

      其中definition_id取自管理仪表板,格式为html,phtml(部分html,用于嵌入。最常见),pdf,json,xml,csv

      2.2对于更复杂的情况,您需要首先创建一个报告实例(这将保存正在运行的报告的状态。您可以执行下一页或检查参数值和选项)。然后,您可以以格式运行报告。

      POST /definitions/{definition_id}/reports 
      

      带有您的选项/参数的正文。您还可以为所有默认值发送空的json正文({})。这将返回带有reportId和位置的json有效内容,以便从

      运行报告
      GET /reports/{report_id}/{format}
      
    2. 您可能还想查看文档中包含的示例(在javascript,java和node中),以了解如何在应用中执行此操作。上面提到的文档也有卷曲的例子。