报表统计图函数

一、报表统计图函数使用说明

1.1 默认加载图表首页 20 条数据 Fx.BI.loadViewData(String viewId)

1.1.1 函数用途

通过viewId查询图表数据

1.1.2 参数说明

参数 类型 是否必须 说明 参数示例
viewId String 是 图表ID
“BI_62174baf180c0b000183a7a6”

1.1.3 返回值说明

参数 类型 说明
code Int 函数状态码:200:成功403:没有权限500:系统异常
message String 返回消息
page Object 分页信息
dispalyFields Object 表头信息
dataSet Object 结果数据集

1.1.4 返回值示例

图表数据返回的结构统一为二维表,表头和数据集分开返回,成对映射

{
  "code": 200,
  "message": "success",
  "i18nCode": null,
  "data": {
    "page": {
      "pageSize": 20,
      "pageNumber": 1,
      "pageCount": 1,
      "totalCount": 3
    },
    "displayFields": [
      {
        "fieldId": "BI_b76b2e080ba679a4d609be4149fa0cf4",
        "fieldName": "客户名称",
        "formatStr": null,
        "apiName": "name",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_name$0"
      },
      {
        "fieldId": "BI_0e3221e80e82809cb750316a81fb8bec",
        "fieldName": "创建人",
        "formatStr": "",
        "apiName": "created_by",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_created_by$0"
      },
      {
        "fieldId": "BI_bacc9e515603edf1e4d765fe3970a043",
        "fieldName": "客户编号",
        "formatStr": null,
        "apiName": "account_no",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_account_no$0"
      },
      {
        "fieldId": "BI_39346e9a9deba83f255db6867dea0f4e",
        "fieldName": "创建时间",
        "formatStr": "yyyy-MM-dd HH:mm",
        "apiName": "create_time",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_create_time$0"
      },
      {
        "fieldId": "BI_92f9670f6a4ed14d17cebabf8501c4f9",
        "fieldName": "最后修改人",
        "formatStr": "",
        "apiName": "last_modified_by",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_last_modified_by$0"
      },
      {
        "fieldId": "BI_86142383c45f86fa2be8c6884dce6eeb",
        "fieldName": "客户层级",
        "formatStr": "",
        "apiName": "account_path",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_account_path$0"
      },
      {
        "fieldId": "BI_2fa0b164273097ce020c607c71b28dc8",
        "fieldName": "客户行业",
        "formatStr": "",
        "apiName": "field_IGh6L__c",
        "objectDescribeApiName": "AccountObj",
        "columnName": "customer_udef_field_igh6l__c$0"
      },
      {
        "fieldId": "BI_49ccf044b0b6b9b720da8006f37b8474",
        "fieldName": "到账日期",
        "formatStr": "yyyy-MM-dd",
        "apiName": "field_rewsS__c",
        "objectDescribeApiName": "AccountObj",
        "columnName": "customer_udef_field_rewss__c$0"
      },
      {
        "fieldId": "BI_4865460605f3905d910d1bffa401a426",
        "fieldName": "value0",
        "formatStr": "",
        "apiName": "value0",
        "objectDescribeApiName": "AccountObj",
        "columnName": "customer_udef_value0$0"
      }
    ],
    "dataSet": [
      [
        {
          "value": "jjjj",
          "formattedValue": "jjjj",
          "formattedShowValue": "jjjj"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1.64610619939E12",
          "formattedValue": "2022-03-01 11:43",
          "formattedShowValue": "1.64610619939E12"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1646841600000",
          "formattedValue": "2022-03-10",
          "formattedShowValue": "1646841600000"
        },
        {
          "value": "621d9656a5db41000156aae0",
          "formattedValue": "621d9656a5db41000156aae0",
          "formattedShowValue": "621d9656a5db41000156aae0"
        }
      ],
      [
        {
          "value": "测试客户",
          "formattedValue": "测试客户",
          "formattedShowValue": "测试客户"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1.646135527393E12",
          "formattedValue": "2022-03-01 19:52",
          "formattedShowValue": "1.646135527393E12"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1646496000000",
          "formattedValue": "2022-03-06",
          "formattedShowValue": "1646496000000"
        },
        {
          "value": "621e08e6a5db4100016247ec",
          "formattedValue": "621e08e6a5db4100016247ec",
          "formattedShowValue": "621e08e6a5db4100016247ec"
        }
      ],
      [
        {
          "value": "费用报销用户1",
          "formattedValue": "费用报销用户1",
          "formattedShowValue": "费用报销用户1"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "1",
          "formattedValue": "1",
          "formattedShowValue": "1"
        },
        {
          "value": "1.645172412386E12",
          "formattedValue": "2022-02-18 16:20",
          "formattedShowValue": "1.645172412386E12"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174",
          "formattedValue": "费用报销客户上级客户/费用报销用户1",
          "formattedShowValue": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1645113600000",
          "formattedValue": "2022-02-18",
          "formattedShowValue": "1645113600000"
        },
        {
          "value": "620f56bccb42760001e9d174",
          "formattedValue": "620f56bccb42760001e9d174",
          "formattedShowValue": "620f56bccb42760001e9d174"
        }
      ]
    ]
  }
}

1.1.5 报表表头信息以及报表数据信息展示

报表头各字段说明表

字段 字段含义 返回样例
objectDescribeApiName pass对象描述
"objectDescribeApiName": "AccountObj"
formatStr 格式化信息
"formatStr": null
fieldName 字段展示名称
"fieldName": "客户名称"
fieldID 字段主键
"fieldId": "BI_b76b2e080ba679a4d609be4149fa0cf4"
columName 唯一列名
"columnName": "biz_account_name$0"
apiName pass字段描述
"apiName": "name"
报表数据详细信息字段说明表
字段 字段含义 返回样例
value 字段值
"value": "jjjj"
formattedValue 字段展示名称
"formattedValue": "jjjj"
formattedShowValue 悬浮值
"formattedShowValue": "jjjj"

1.1.6 函数DEMO1

      /加载图表数据*****/
      +++++++++++++++++++++++++++++++++++++++++++++++++Fx.BI.getFiltersResult(String viewId)方法+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

      def(isError4,data4,errorMsg4) = Fx.BI.loadViewData("BI_62174baf180c0b000183a7a6")
      if(!isError4){
      def page = data4["page"]
      log.info("第1页数据集:"+data4["dataSet"])

      ====================================================================================================================================================================
      +++++++++++如果要查询所有数据集,要联合 Fx.BI.pageLoadViewData(String viewId,Integer pageNumber,Integer pageSize)方法,结合这两部分的代码+++++++++++++++++++++

      if(page!=null){
      def pageCount = page["pageCount"] as Integer
      def pageSize = page["pageSize"] as Integer
      if(pageCount>1){
      Range range = Ranges.of(2,pageCount.intValue())
      range.each { i ->
      def (isErrorTmp,dataTmp,errorMsgTmp) = Fx.BI.pageLoadViewData("BI_62174baf180c0b000183a7a6",i,pageSize)
      log.info("第"+i+"页数据集:"+dataTmp["dataSet"])
      /拿到DataSet就可以业务自己后续处理了/
      }
      }
      }
      }

1.2 加载第 i 页图表数据 Fx.BI.pageLoadViewData(String viewId, Integer pageNumber, Integer pageSize)

1.2.1 函数用途

查询第i页图表数据

注意:此函数可以在已知有多少页的情况下进行查询每页的数据集,通常可以配合方法

Fx.BI.loadViewData(String viewId)

进行查找所有页数据集,详细见代码DEMO1

1.2.2 参数说明

参数 类型 是否必须 说明 参数示例
viewId String 是 图表ID
“BI_62174baf180c0b000183a7a6”
pageNumber Integer 是 页码 1
pageSize Integer 是 单页记录数 20

1.2.3 返回值说明

参数 类型 说明
参数 类型 说明
code Int 函数状态码:200:成功403:没有权限500:系统异常
message String 返回消息
page Object 分页信息
dispalyFields Object 表头信息
dataSet Object 结果数据集

1.2.4 返回值示例

图表数据返回的结构统一为二维表,表头和数据集分开返回,成对映射

{
  "code": 200,
  "message": "success",
  "i18nCode": null,
  "data": {
    "page": {
      "pageSize": 20,
      "pageNumber": 1,
      "pageCount": 1,
      "totalCount": 3
    },
    "displayFields": [
      {
        "fieldId": "BI_b76b2e080ba679a4d609be4149fa0cf4",
        "fieldName": "客户名称",
        "formatStr": null,
        "apiName": "name",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_name$0"
      },
      {
        "fieldId": "BI_0e3221e80e82809cb750316a81fb8bec",
        "fieldName": "创建人",
        "formatStr": "",
        "apiName": "created_by",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_created_by$0"
      },
      {
        "fieldId": "BI_bacc9e515603edf1e4d765fe3970a043",
        "fieldName": "客户编号",
        "formatStr": null,
        "apiName": "account_no",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_account_no$0"
      },
      {
        "fieldId": "BI_39346e9a9deba83f255db6867dea0f4e",
        "fieldName": "创建时间",
        "formatStr": "yyyy-MM-dd HH:mm",
        "apiName": "create_time",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_create_time$0"
      },
      {
        "fieldId": "BI_92f9670f6a4ed14d17cebabf8501c4f9",
        "fieldName": "最后修改人",
        "formatStr": "",
        "apiName": "last_modified_by",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_last_modified_by$0"
      },
      {
        "fieldId": "BI_86142383c45f86fa2be8c6884dce6eeb",
        "fieldName": "客户层级",
        "formatStr": "",
        "apiName": "account_path",
        "objectDescribeApiName": "AccountObj",
        "columnName": "biz_account_account_path$0"
      },
      {
        "fieldId": "BI_2fa0b164273097ce020c607c71b28dc8",
        "fieldName": "客户行业",
        "formatStr": "",
        "apiName": "field_IGh6L__c",
        "objectDescribeApiName": "AccountObj",
        "columnName": "customer_udef_field_igh6l__c$0"
      },
      {
        "fieldId": "BI_49ccf044b0b6b9b720da8006f37b8474",
        "fieldName": "到账日期",
        "formatStr": "yyyy-MM-dd",
        "apiName": "field_rewsS__c",
        "objectDescribeApiName": "AccountObj",
        "columnName": "customer_udef_field_rewss__c$0"
      },
      {
        "fieldId": "BI_4865460605f3905d910d1bffa401a426",
        "fieldName": "value0",
        "formatStr": "",
        "apiName": "value0",
        "objectDescribeApiName": "AccountObj",
        "columnName": "customer_udef_value0$0"
      }
    ],
    "dataSet": [
      [
        {
          "value": "jjjj",
          "formattedValue": "jjjj",
          "formattedShowValue": "jjjj"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1.64610619939E12",
          "formattedValue": "2022-03-01 11:43",
          "formattedShowValue": "1.64610619939E12"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1646841600000",
          "formattedValue": "2022-03-10",
          "formattedShowValue": "1646841600000"
        },
        {
          "value": "621d9656a5db41000156aae0",
          "formattedValue": "621d9656a5db41000156aae0",
          "formattedShowValue": "621d9656a5db41000156aae0"
        }
      ],
      [
        {
          "value": "测试客户",
          "formattedValue": "测试客户",
          "formattedShowValue": "测试客户"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1.646135527393E12",
          "formattedValue": "2022-03-01 19:52",
          "formattedShowValue": "1.646135527393E12"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1646496000000",
          "formattedValue": "2022-03-06",
          "formattedShowValue": "1646496000000"
        },
        {
          "value": "621e08e6a5db4100016247ec",
          "formattedValue": "621e08e6a5db4100016247ec",
          "formattedShowValue": "621e08e6a5db4100016247ec"
        }
      ],
      [
        {
          "value": "费用报销用户1",
          "formattedValue": "费用报销用户1",
          "formattedShowValue": "费用报销用户1"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "1",
          "formattedValue": "1",
          "formattedShowValue": "1"
        },
        {
          "value": "1.645172412386E12",
          "formattedValue": "2022-02-18 16:20",
          "formattedShowValue": "1.645172412386E12"
        },
        {
          "value": "1067",
          "formattedValue": "bi",
          "formattedShowValue": "1067"
        },
        {
          "value": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174",
          "formattedValue": "费用报销客户上级客户/费用报销用户1",
          "formattedShowValue": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174"
        },
        {
          "value": "null",
          "formattedValue": "--",
          "formattedShowValue": null
        },
        {
          "value": "1645113600000",
          "formattedValue": "2022-02-18",
          "formattedShowValue": "1645113600000"
        },
        {
          "value": "620f56bccb42760001e9d174",
          "formattedValue": "620f56bccb42760001e9d174",
          "formattedShowValue": "620f56bccb42760001e9d174"
        }
      ]
    ]
  }
}

1.2.5 报表表头信息以及报表数据信息展示

报表头各字段说明表

字段 字段含义 返回样例
fieldID 字段主键
"fieldId": "BI_b76b2e080ba679a4d609be4149fa0cf4"
fieldName 字段展示名称
"fieldName": "客户名称"
formatStr 格式化信息
"formatStr": null 
apiName pass字段描述
"apiName": "name"
objectDescribeApiName pass对象描述
"objectDescribeApiName": "AccountObj"
columName 唯一列名
"columnName": "biz_account_name$0"
报表数据详细信息字段说明表
字段 字段含义 返回样例
value 字段值
"value": "jjjj"
formattedValue 字段展示名称
"formattedValue": "jjjj"
formattedShowValue 悬浮值
"formattedShowValue": "jjjj"

1.2.6 函数DEMO2

/**查询第i页数据集**/
+++++++++++++++++++++Fx.BI.pageLoadViewData(String viewId,Integer pageNumber,Integer pageSize)方法++++++++++++++++++++++++++++++
======================================================================================================================================
    def (isErrorTmp,dataTmp,errorMsgTmp) = Fx.BI.pageLoadViewData("BI_62174baf180c0b000183a7a6",i,pageSize)
    log.info("第"+i+"页数据集:"+dataTmp["dataSet"])
    /*拿到DataSet就可以业务自己后续处理了*/

1.3 条件查询图表数据(默认返回首页 20 条) Fx.BI.queryViewData(String viewId, String defaultFilterOptionID, List filters)

1.3.1 函数用途

注意:此函数只能查询一页的数据,如果要查询所有数据,需要联合这个函数

Fx.BI.pageQueryViewData(String viewId,Integer pageNum,Integer pageSize,String defaultFilterOptionID,List filters)

,看下方示例代码

1.3.2 参数说明

参数 类型 是否必须 说明 参数示例
参数 类型 是否必须 说明 参数示例
viewId String 是 图表ID
“BI_62174baf180c0b000183a7a6”
defaultFilterOptionID String 是 场景ID
“BI_59a3e59333b39e09b44e9db1”
filters List 否 筛选条件(包括数据范围和场景筛选)
["filterId":"BI_62174baf180c0b000183a7aa","dataRangeId":"6"]

1.3.3 返回值说明

参数 类型 说明
code Int 函数状态码:200:成功403:没有权限500:系统异常
message String 返回消息
page Object 分页信息
dispalyFields Object 表头信息
dataSet Object 结果数据集

1.3.4 返回值示例

图表数据返回的结构统一为二维表,表头和数据集分开返回,成对映射

{
"code": 200,
"message": "success",
"i18nCode": null,
"data": {
"page": {
"pageSize": 20,
"pageNumber": 20,
"pageCount": 1,
"totalCount": 2
},
"displayFields": [
{
"fieldId": "BI_b76b2e080ba679a4d609be4149fa0cf4",
"fieldName": "客户名称",
"apiName": "name",
"objectDescribeApiName": "AccountObj",
"columnName": "biz_account_name$0"
},
{
"fieldId": "BI_bacc9e515603edf1e4d765fe3970a043",
"fieldName": "客户编号",
"apiName": "account_no",
"objectDescribeApiName": "AccountObj",
"columnName": "biz_account_account_no$0"
}
],
"dataSet": [
[
{
"value": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174",
"formattedValue": "费用报销客户上级客户/费用报销用户1",
"formattedShowValue": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174"
},
{
"value": "1645113600000",
"formattedValue": "2022-02-18",
"formattedShowValue": "1645113600000"
}
]
]
}
}

报表头各字段说明表

字段 字段含义 返回样例
fieldID 字段主键
"fieldId": "BI_b76b2e080ba679a4d609be4149fa0cf4"
fieldName 字段展示名称
"fieldName": "客户名称"
apiName pass字段描述
"apiName": "name"
objectDescribeApiName pass对象描述
"objectDescribeApiName": "AccountObj"
columName 唯一列名
"columnName": "biz_account_name$0"
报表数据详细信息字段说明表
字段 字段含义 返回样例
value 字段值
"value": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174", 
formattedValue 字段展示名称
"formattedValue": "费用报销客户上级客户/费用报销用户1",
formattedShowValue 悬浮值
"formattedShowValue": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174"

1.3.5 函数DEMO3

/**条件查询*/
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++Fx.BI.queryViewData(String viewId,String optionId,List filters)方法,按条件查询表中数据(只能查询一页数据)++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
==========================================================================================================================================================================================================================================

List filters = [["filterId":"BI_62174baf180c0b000183a7aa","dateRangeId":"6"]]
def(isError6,data6,errorMsg6) = Fx.BI.queryViewData("BI_62174baf180c0b000183a7a6","BI_59a3e59333b39e09b44e9db1",filters)
if(!isError6){
  def page6 = data6["page"]
  log.info("第1页数据集:"+data6["dataSet"])

===========================================================================================================================================================================================================================================
++++++++++++++++++++++++++++++如果要查询所有数据联合下方的Fx.BI.pageQueryViewData(String viewId,Integer pageNumber,Integer pageSize,String defaultFilterOptionID,List filters)方法+++++++++++++++++++++++++++++++++++++++++++++++
===========================================================================================================================================================================================================================================
  if(page6!=null){
  def pageCount6 = page6["pageCount"] as Integer
  def pageSize6 = page6["pageSize"] as Integer
  if(pageCount6>1){
    Range range6 = Ranges.of(2,pageCount6.intValue())
  range6.each { i ->
    def (isErrorTmp,dataTmp,errorMsgTmp) = Fx.BI.pageQueryViewData("BI_62174baf180c0b000183a7a6",i,pageSize6,"BI_59a3e59333b39e09b44e9db1",filters)
    log.info("第"+i+"页数据集:"+dataTmp["dataSet"])
    /*拿到DataSet就可以业务自己后续处理了*/
  }
  }
  }
}else{
  log.info("条件查询失败:"+errorMsg6)
}

1.4 条件查询第 i 页数据集 Fx.BI.pageQueryViewData(String viewId, Integer pageNumber, Integer pageSize, String defaultFilterOptionID, List filters)

1.4.1 函数用途

按指定条件和指定页数查询图表数据

注意:此函数可以在已知有多少页的情况下进行查询每页的数据集,通常可以配合方法

Fx.BI.queryViewData(String viewId,String defaultFilterOptionID,List filters)

进行查找所有页数据集,详细见代码DEMO3

1.4.2 参数说明

参数 类型 是否必须 说明
viewId String 是 图表ID
pageNumber Integer 是 页码
pageSize Integer 是 单页记录数
defaultFilterOptionID String 是 权限场景
filters List 是 筛选条件

1.4.3 返回值说明

参数 类型 说明
code Int 函数状态码:200:成功403:没有权限500:系统异常
message String 返回消息
page Object 分页信息
dispalyFields Object 表头信息
dataSet Object 结果数据集

1.4.4 返回值示例

图表数据返回的结构统一为二维表,表头和数据集分开返回,成对映射

{
"code": 200,
"message": "success",
"i18nCode": null,
"data": {
"page": {
"pageSize": 20,
"pageNumber": 20,
"pageCount": 1,
"totalCount": 2
},
"displayFields": [
{
"fieldId": "BI_b76b2e080ba679a4d609be4149fa0cf4",
"fieldName": "客户名称",
"apiName": "name",
"objectDescribeApiName": "AccountObj",
"columnName": "biz_account_name$0"
},
{
"fieldId": "BI_bacc9e515603edf1e4d765fe3970a043",
"fieldName": "客户编号",
"apiName": "account_no",
"objectDescribeApiName": "AccountObj",
"columnName": "biz_account_account_no$0"
}
],
"dataSet": [
[
{
"value": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174",
"formattedValue": "费用报销客户上级客户/费用报销用户1",
"formattedShowValue": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174"
},
{
"value": "1645113600000",
"formattedValue": "2022-02-18",
"formattedShowValue": "1645113600000"
}
]
]
}
}

报表头各字段说明表

字段 字段含义 返回样例
字段 字段含义 返回样例
fieldID 字段主键
"fieldId": "BI_b76b2e080ba679a4d609be4149fa0cf4" 
fieldName 字段展示名称
"fieldName": "客户名称" 
apiName pass字段描述
"apiName": "name" 
objectDescribeApiName pass对象描述
"objectDescribeApiName": "AccountObj" 
columName 唯一列名
"columnName": "biz_account_name$0" 
报表数据详细信息字段说明表
字段 字段含义 返回样例
value 字段值
"value": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174", 
formattedValue 字段展示名称
"formattedValue": "费用报销客户上级客户/费用报销用户1",
formattedShowValue 悬浮值
"formattedShowValue": "620f56eacb42760001e9d6c1.620f56bccb42760001e9d174" 

1.4.5 函数DEMO4

===========================================================================================================================================================================================================================================
+++++++++++++++++++++++++++++++++++++++++++++++++Fx.BI.pageQueryViewData(String viewId,Integer pageNumber,Integer pageSize,String defaultFilterOptionID,List filters)方法++++++++++++++++++++++++++++++++++++++++++++++++++++++++
===========================================================================================================================================================================================================================================
 /**条件查询第i页的图表数据集*/
def (isErrorTmp,dataTmp,errorMsgTmp) = Fx.BI.pageQueryViewData("BI_62174baf180c0b000183a7a6",i,pageSize6,"BI_59a3e59333b39e09b44e9db1",filters)
    log.info("第"+i+"页数据集:"+dataTmp["dataSet"])
    /*拿到DataSet就可以业务自己后续处理了*/

1.5 获取图表的数据范围以及场景 Fx.BI.getFiltersResult(String viewId)

1.5.1 函数用途

按指定条件查询图表的数据范围以及场景

1.5.2 参数说明

参数 类型 是否必须 说明
viewId String 是 图表ID

1.5.3 返回值说明

参数 类型 说明
code Int 函数状态码:200:成功403:没有权限404:未找到500:系统异常
message String 返回消息
filterGroups Object 数据范围信息
labelAndOptions Object 场景信息

1.5.4 返回值示例

图表数据返回的结构统一为二维表,表头和数据集分开返回,成对映射

{
  "code": 200,
  "message": "success",
  "i18nCode": null,
  "data": {
    "filterGroups": [
      {
        "filters": [
          {
            "filterId": "BI_62174baf180c0b000183a7a9",
            "value1": "[{"id":999999,"type":"c"}]",
            "value2": "",
            "dateRangeId": null
          },
          {
            "filterId": "BI_62174baf180c0b000183a7aa",
            "value1": "2022-01-01",
            "value2": "2022-12-31",
            "dateRangeId": null
          },
          {
            "filterId": "BI_62174baf180c0b000183a7ab",
            "value1": "2022-01-01 00:00",
            "value2": "2022-12-31 23:59",
            "dateRangeId": null
          },
          {
            "filterId": "BI_62174baf180c0b000183a7ac",
            "value1": "[{"id":999999,"type":"c"}]",
            "value2": "",
            "dateRangeId": null
          }
        ]
      }
    ],
    "labelAndOptions": [
      {
        "defaultFilterOptionID": null,
        "defaultFilterOptionType": "UDF",
        "label": "场景",
        "defaultFilterOptions": [
          {
            "optionName": "全部",
            "isDefault": 1,
            "optionID": "BI_59a3e59333b39e09b44e9db1"
          },
          {
            "optionName": "我负责的",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db2"
          },
          {
            "optionName": "我联合跟进的",
            "isDefault": 0,
            "optionID": "BI_171714538838884352"
          },
          {
            "optionName": "我服务的",
            "isDefault": 0,
            "optionID": "BI_171714538872438784"
          },
          {
            "optionName": "我参与的",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db3"
          },
          {
            "optionName": "我负责部门的",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db4"
          },
          {
            "optionName": "我下属负责的",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db5"
          },
          {
            "optionName": "我下属联合跟进的",
            "isDefault": 0,
            "optionID": "BI_171714538939547648"
          },
          {
            "optionName": "我下属服务的",
            "isDefault": 0,
            "optionID": "BI_171714538973102080"
          },
          {
            "optionName": "我下属参与的",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db6"
          },
          {
            "optionName": "共享给我的",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db7"
          }
        ]
      }
    ]
  }
}

1.5.5 返回值代码与示例图对照展示

字段 字段含义 返回样例
dataRangeId 日期筛选需要
"dateRangeId": null 
filterId 筛选器主键
"filterId": "BI_62174baf180c0b000183a7a9", 
value1 默认筛选范围
 "value1": "[{"id":999999,"type":"c"}]","value1": "[{"id":999999,"type":"c"}]",
value2 默认筛选范围
"value2": "", 
场景信息(labelAndOptions)
字段 字段含义 返回样例
optionName 场景选项名称
"optionName": "全部" 
isDefault 是否默认(1:默认 )
"isDefault": 1 
optionID 场景选项ID
"optionID": "BI_59a3e59333b39e09b44e9db1" 

1.5.6 函数DEMO5

/*加载图表筛选器*/
++++++++++++++++++++++++++++++++++++++++++++++ Fx.BI.getFiltersResult(String viewId)方法++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
=====================================================================================================================================================
def(isError5,data5,errorMsg5) = Fx.BI.getFiltersResult("BI_62174baf180c0b000183a7a6")
if(!isError5){
  log.info("筛选器信息:"+data5["filterGroups"])
  log.info("场景信息:"+data5["labelAndOptions"])
  /*可根据FilterId修改筛选器值进行查询,值的结构可参考报表运行态传参结构*/
}

1.6 使用filterList注意事项:日期筛选case和枚举项

注意:如果筛选范围为日期筛选的话,需要在filterList添加一个条件,如果日期筛选不加这个条件是会失败的

例如:

”dataRangeId“:6

,代表本年度,需要的枚举值和介绍见下图

2026-09-18
0 0