API数据集

本文将指引您完成积木报表API数据集的开发，文章将分两部分说明，其一为谷神端开发说明；其二为积木报表端配置说明。

谷神端服务组件开发说明

• 谷神端需要创建服务组件用于对接积分报表API的访问
• 服务组件必须为地址映射型，访问控制必须为登录权限
• 返回类型必须： application/json
  
• 服务组件返回数据格式由两种选择：
  • 谷神分页数据格式（此模式积木报表API那边一定要配置类转换器），
    

    若您的组件返回的是谷神分页对象，则再配置积木API数据时，请配置类转换器

  • 无分页积木数据格式（格式详情见积木报表API文档）
    

    {
     "data": [{
         "KEY1": "VALUE1",
         "KEY2": "VALUE2"
     }]
    }

积木端API数据集配置说明

• 创建数据集时，选择API数据集，API数据集配置说明如下文
• 请求方式：get
• 类转换器：
  • 若谷神服务组件返回的是标准数据（根据积木数据结构返回），则可以保持空
  • 若服务组件返回的是谷神page对象，则需要设置为定制转换器：com.guthon.plugins.jimureport.guthonPageDataAdapter
• API地址示例：
  • #{domainURL}/gdpaas/comp/mreport/data.htm
  • #{domainURL}为谷神主数据服务根地址(含servletPath)
  • /gdpaas/comp/mreport/data.htm 为您创建的服务组件的映射地址
• 查询参数说明：
  • 可以在API地址里拼接查询参数，如：#{domainURL}/gdpaas/comp/mreport/data.htm?DEPT_CODE=’${DEPT_CODE}’&BILL_NO=’${BILL_NO}’
  • 参数可以在谷神服务组件 $form 对象里读取，如： $form.DEPT_CODE
• 点击API解析按钮，就可以正常查出数据了，其他报表设计同SQL数据集，本文不再重复阐述