页面树结构

版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。
评论: smartbi-nla接口更新

...


URL参数名

URL参数值


输入参数

className

UserService


methodName

clickLogin


params

userName

样例:["demo","demo"]

password

返回值

retCode

0

非0表示错误

result

true

非0时是错误信息

4.2 登录NLA


URL参数名

URL参数值

说明

输入参数

className

AIChatRemoteService


methodName

loginIfSmartbiLogged


params

[]

样例:[]

返回值

retCode

0

非0表示错误

result

{\"token\":\"CE3CE70AC12B70052A507D4B560E5374\"}

NLA 的token信息,这个非常重要,后续NLA所有方法需要用到这个token;

非0时是错误信息

4.3 查询数据模型清单、推荐问句


URL参数名

URL参数值

说明

输入参数

className

AIChatRemoteService


methodName

getBuildThemes


params

token

loginIfSmartbiLogged方法获取的token

返回值

retCode

0

参考query方法

result


参考query方法

...

返回参数名

返回值说明

reCode

接口调用是否成功;大于等于0 - 表示成功;负数为错误码

result

调用接口的返回内容,登录接口的返回内容说明如下:

"id":                          数据模型themeID

"name":                       数据模型名称

"title":                        数据模型名称别名

"desc":                      数据模型概览    

"type":                        数据类型

"recommendQuestion":           推荐问句

"lastBuildTime":                 最近构建时间

...


其他返回值可以忽略

4.

...

4 维度指标树、推荐问句


URL参数名

URL参数值

说明

输入参数

className

AIChatRemoteService


methodName

getDataSetInfoSummary


params

token

loginIfSmartbiLogged方法获取的token

sourceId

用户在界面上选择的数据模型themeId

返回值

retCode

0

参考query方法

result


参考query方法

...

返回参数名

返回值说明

retCode

接口调用是否成功;大于等于0 - 表示成功;负数为错误码

message

错误描述,code=0 时,该内容为空

token

登录方法特有内容,这个非常重要,后续接口需要传递该值以验证登录

result

调用接口的返回内容,登录接口的返回内容说明如下:

"html":                        切换后的图表的html

"portletType":                  切换后的图标的类型

...


其他返回值可以忽略

4.

...

8 查询结果设置输出行数





5. Demo开发设计

本次教程,仅以Web开发作为示例,说明如何调用Smartbi NLA的二次开发API实现自定义对话界面的过程。Android应用和IOS应用基本调用API的方法是一致的,区别只是使用的开发平台不同。开发工程师需要在对应的开发平台上做调整。

...