1. getRules Query BI chart target rule names and IDs

Query BI chart target rule names and IDs

Fx.BI.getRules(<String viewId>)

Request parameters

Request Body

Parameter Name	Type	Description	Required
viewId	String	View ID used to specify the target rule of the view to be queried	Y

Return Parameters

Parameter Name	Type	Description
userFilters	Array[object]	User-defined filter conditions
defaultFilterOptions	Array[Object]	Default filter options list
measureFields	Array[Object]	Measure fields list
rules	Array[Object]	Rules list

defaultFilterOptions	Object	Description
defaultOrNot	Integer	Whether it is the default option (1 for yes, 0 for no)
optionID	String	Option ID
optionName	String	Option name

measureFields	Object	Description
fieldName	String	Field name
fieldID	String	Field ID

rules	Object	Description
nodeName	String	Node name
enumId	String	Enumeration ID
optionCode	String	Option code
isSelected	Integer	Whether selected (0 for unselected)
childList	Array[object]	Child nodes list
isHaveChild	Integer	Whether has child nodes (0 for none)
parentID	String	Parent node ID
order	Integer	Sorting order

Return an example

[
    {
        "userFilters": [],
        "defaultFilterOptions": [
            {
                "defaultOrNot": 1,
                "optionID": "BI_59a3e59333b39e09b44e9db1",
                "optionName": "All"
            },
            {
                "defaultOrNot": 0,
                "optionID": "BI_59a3e59333b49e29b04e0db2",
                "optionName": "Published"
            },
            {
                "defaultOrNot": 0,
                "optionID": "BI_59a3e59333b49e29b04e0qb2",
                "optionName": "Unpublished"
            },
            {
                "defaultOrNot": 0,
                "optionID": "BI_59a3e59333b39e09b44e9db2",
                "optionName": "Assigned to Me"
            },
            {
                "defaultOrNot": 0,
                "optionID": "BI_59a3e59333b39e09b44e9db3",
                "optionName": "Participated by Me"
            },
            {
                "defaultOrNot": 0,
                "optionID": "BI_59a3e59333b39e09b44e9db4",
                "optionName": "Assigned to My Department"
            },
            {
                "defaultOrNot": 0,
                "optionID": "BI_59a3e59333b39e09b44e9db5",
                "optionName": "Assigned to My Subordinates"
            },
            {
                "defaultOrNot": 0,
                "optionID": "BI_59a3e59333b39e09b44e9db6",
                "optionName": "Participated by My Subordinates"
            },
            {
                "defaultOrNot": 0,
                "optionID": "BI_59a3e59333b39e09b44e9db7",
                "optionName": "Shared with Me"
            }
        ],
        "measureFields": [
            {
                "fieldName": "Monthly Target Value",
                "fieldID": "BI_a9766b081e45837da44f71c6965bbaf5"
            },
            {
                "fieldName": "Completion Value",
                "fieldID": "BI_d42f1fad5601af69cd6d1a30c54b2fc9"
            }
        ],
        "rules": [
            {
                "nodeName": "Product Multilingual CES",
                "enumId": "63bd3a0aa811cf0001ab4b3a",
                "optionCode": "63bd3a0aa811cf0001ab4b3a",
                "isSelected": 0,
                "childList": [],
                "isHaveChild": 0,
                "parentID": "-2",
                "order": 0
            },
            {
                "nodeName": "Product",
                "enumId": "63dbd41411782d00018f37cd",
                "optionCode": "63dbd41411782d00018f37cd",
                "isSelected": 0,
                "childList": [],
                "isHaveChild": 0,
                "parentID": "-2",
                "order": 0
            }
        ]
    }
]

Code examples

def(isError3, data3, errorMsg3) = Fx.BI.getRules("BI_60f787675f32870001714eb8")
if(!isError3){
  log.info("Data information:" + data3["page"])
}else{
  log.info("Query failed:" + errorMsg3)
}

Owner：翟付杰Jeffrey

2. getTargetCompletion Get Target Completion Rate

Obtain Target Completion Rate

Fx.BI.getTargetCompletion(<String viewId>, <类型 userFilters>, <Array targetIds>, <String optionId>)

Request parameters

Request Body

Parameter Name	Type	Description	Required
viewId	String	View ID	Y
userFilters	Type	User filters	Y
targetIds	Array[String]	List of target IDs	Y
optionId	String	Scenario ID	Y

userFilters	Type	User filters	Required
userFilters	Array[Object]	List of user filters	Y
ruleFilters	Type		Y
isShowDimension	Integer	Whether to display dimension: 0-No, 1-Yes	Y

userFilters	Object	Description	Required
fieldId	String	Field ID	Y
targetType	Integer	Target type: 0-Personal, 1-Department, 2-Date	Y
value	Array[Type]	Filter values, which may be numbers, arrays or strings depending on target type	Y

ruleFilters	Type	Description	Required
optionCode	Array[String]	List of option codes	Y
isChild	Integer	Whether it's a child item: 0-No, 1-Yes	Y

Return Parameters

Parameter Name	Type	Description
Param1	Boolean	Indicates whether an error occurred. false means no error
Param2	Array	Field data list
Param3	String	Error message, empty string when no error occurs

Return an example

[
    false,
    [
        {
            "fieldName": "Material Code",
            "value": [
                {
                    "formattedValue": "123",
                    "formattedShowValue": "123",
                    "valueCode": "123$$65672428c70f2f00017e0788",
                    "value": "123"
                },
                {
                    "formattedValue": "Cute little dog",
                    "formattedShowValue": "Cute little dog",
                    "valueCode": "Cute little dog$$65af8fc7ea1c430007aa6d13",
                    "value": "Cute little dog"
                },
                {
                    "formattedValue": "sy#f00>Feb*",
                    "formattedShowValue": "sy#f00>Feb*",
                    "valueCode": "sy#f00>Feb*",
                    "value": "sy#f00>Feb*"
                }
            ],
            "fieldId": "BI_5be1388756fc11448c4567d8"
        },
        {
            "fieldName": "Responsible Person",
            "value": [
                {
                    "formattedValue": "Zhong-bi2",
                    "formattedShowValue": "Zhong-bi2",
                    "valueCode": "1067",
                    "value": "Zhong-bi2"
                },
                {
                    "formattedValue": "Zhong-Xiaoha (Deactivated)",
                    "formattedShowValue": "Zhong-Xiaoha (Deactivated)",
                    "valueCode": "3264",
                    "value": "Zhong-Xiaoha (Deactivated)"
                },
                {
                    "formattedValue": "sy#f00>Feb*",
                    "formattedShowValue": "sy#f00>Feb*",
                    "valueCode": "sy#f00>Feb*",
                    "value": "sy#f00>Feb*"
                }
            ],
            "fieldId": "BI_5be1388756fc11448c456809"
        },
        {
            "fieldName": "Monthly Target",
            "value": [
                {
                    "formattedValue": "12K",
                    "formattedShowValue": "11,988",
                    "valueCode": 11988,
                    "value": 11988
                },
                {
                    "formattedValue": "12.00",
                    "formattedShowValue": "12",
                    "valueCode": 12,
                    "value": 12
                },
                {
                    "formattedValue": "12K",
                    "formattedShowValue": "12,000",
                    "valueCode": 12000.0,
                    "value": 12000.0
                }
            ],
            "fieldId": "BI_a9766b081e45837da44f71c6965bbaf5"
        },
        {
            "fieldName": "Completion Value",
            "value": [
                {
                    "formattedValue": "0.00",
                    "formattedShowValue": "0.00",
                    "valueCode": 0,
                    "value": 0
                },
                {
                    "formattedValue": "0.00",
                    "formattedShowValue": "0.00",
                    "valueCode": 0,
                    "value": 0
                },
                {
                    "formattedValue": "0.00",
                    "formattedShowValue": "0.00",
                    "valueCode": 0,
                    "value": 0
                }
            ],
            "fieldId": "BI_d42f1fad5601af69cd6d1a30c54b2fc9"
        }
    ],
    ""
]

Code examples

Map userFilters = [
        "userFilters"    : [
                [
                        "fieldId"   : "BI_5bcec12156fc11160c10043d",
                        "targetType": 0,// (0: individual, 1: department, 2: date)
                        "value"     : [1067]
                ],
                [
                        "fieldId"   : "BI_5bcec12156fc11160c100443",
                        "targetType": 2,// (0: individual, 1: department, 2: date)
                        "value"     : ["2021-01-01", "2021-02-01"]
                ]
        ],
        "ruleFilters"    : [
                "optionCode": ["6079743a2822bb000156541b"],
                "isChild"   : 0
        ],
        "isShowDimension": 0
]
def rules = Fx.BI.getTargetCompletion("BI_60f787675f32870001714eb8", userFilters, ["BI_nvv76jyhwg6qoojfw9ike31u"], "BI_59a3e59333b39e09b44e9db1")
Fx.log.info(rules)

Owner：翟付杰Jeffrey

3. loadViewData Chart Data Loading

Chart Data Loading

Fx.BI.loadViewData(<String viewId>)

Request parameters

Request Body

Parameter Name	Type	Description	Required
viewId	String	View ID used to specify the view to be queried	Y

Return Parameters

Parameter Name	Type	Description
displayFields	Object[object]	Defines the field information displayed in the view
dataSet	Array[array]	Query result dataset

displayFields	object	Description
fieldName	String	Field display name
viewFieldId	String	View field ID
fieldId	String	Field ID

dataSet	Data Item	Description
formattedValue	String	Formatted value
formattedShowValue	String	Formatted display value
valueCode	String	Value code, may contain reference ID
value	String	Original value

Return an example

{
    "displayFields": [
        {
            "fieldName": "Customer Name",
            "viewFieldId": "BI_682ae4f89a6d0e000111052f",
            "fieldId": "BI_5bcebcddcab2980001ee22ab"
        },
        {
            "fieldName": "Order Amount",
            "viewFieldId": "BI_682ae4f99a6d0e0001110530",
            "fieldId": "BI_5bceda90dedd2c0001c2f54e"
        }
    ],
    "dataSet": [
        [
            {
                "formattedValue": "Multi-Dimensional Fruit 1",
                "formattedShowValue": "Multi-Dimensional Fruit 1",
                "valueCode": "Multi-Dimensional Fruit 1$$60f14d96fd6db100011adaeb",
                "value": "Multi-Dimensional Fruit 1"
            },
            {
                "formattedValue": "15.3K",
                "formattedShowValue": "15,300.00",
                "valueCode": "15300.0",
                "value": "15300.0"
            }
        ],
        [
            {
                "formattedValue": "Multi-Dimensional Fruit 10",
                "formattedShowValue": "Multi-Dimensional Fruit 10",
                "valueCode": "Multi-Dimensional Fruit 10$$60f14d96fd6db100011adaf9",
                "value": "Multi-Dimensional Fruit 10"
            },
            {
                "formattedValue": "15.39K",
                "formattedShowValue": "15,390.00",
                "valueCode": "15390.0",
                "value": "15390.0"
            }
        ]
    ]
}

Code examples

def(isError3, data3, errorMsg3) = Fx.BI.loadViewData("BI_673c850d1e4ac70001e4027f")
if(!isError3){
  log.info("Data information:" + Fx.json.toJson(data3))
}else{
  log.info("Query failed:" + errorMsg3)
}

Owner：翟付杰Jeffrey

4. getFiltersResult Get Chart Filters

Get chart filter

Fx.BI.getFiltersResult(<String viewId>)

Request parameters

Request Body

Parameter Name	Type	Description	Required
viewId	String	View ID used to specify the view filter for querying	Y

Return Parameters

Parameter Name	Type	Description
data	Type

data	Type	Description
filterGroups	Array[Type]	List of filter groups
labelAndOptions	Array[Object]	List of labels and options

filterGroups	Type	Description
filters	Array[Type]

filters	Type	Description
filterId	String	Filter ID
value1	String	Filter value 1, could be JSON string or date string
value2	String	Filter value 2, typically used as end date for date range
dateRangeId	String	Null

labelAndOptions	Object	Description
defaultFilterOptionID	String	Null
defaultFilterOptionType	String	Default filter option type
label	String	Label name
defaultFilterOptions	Array[Object]	List of default filter options

defaultFilterOptions	Object	Description
optionName	String	Option name
isDefault	Integer	Whether default option (1 for yes, 0 for no)
optionID	String	Option ID

Return an example

"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": "Scenario",
        "defaultFilterOptions": [
          {
            "optionName": "All",
            "isDefault": 1,
            "optionID": "BI_59a3e59333b39e09b44e9db1"
          },
          {
            "optionName": "Assigned to Me",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db2"
          },
          {
            "optionName": "Co-followed by Me",
            "isDefault": 0,
            "optionID": "BI_171714538838884352"
          },
          {
            "optionName": "Served by Me",
            "isDefault": 0,
            "optionID": "BI_171714538872438784"
          },
          {
            "optionName": "Participated by Me",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db3"
          },
          {
            "optionName": "Assigned to My Department",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db4"
          },
          {
            "optionName": "Assigned to My Subordinates",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db5"
          },
          {
            "optionName": "Co-followed by My Subordinates",
            "isDefault": 0,
            "optionID": "BI_171714538939547648"
          },
          {
            "optionName": "Served by My Subordinates",
            "isDefault": 0,
            "optionID": "BI_171714538973102080"
          },
          {
            "optionName": "Participated by My Subordinates",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db6"
          },
          {
            "optionName": "Shared with Me",
            "isDefault": 0,
            "optionID": "BI_59a3e59333b39e09b44e9db7"
          }
        ]
      }
    ]
  }

Code examples

def(isError5, data5, errorMsg5) = Fx.BI.getFiltersResult("BI_6747dff28443340001454164")
if(!isError5){
  log.info("Filter information:" + Fx.json.toJson(data5))
  /*You can modify the filter values based on FilterId for querying. The value structure can refer to the report runtime parameter passing structure*/
} else {
    log.info("Query failed:" + errorMsg5)
}

Owner：翟付杰Jeffrey

5. pageLoadViewData Chart Data Loading

Chart Data Loading

Fx.BI.pageLoadViewData(<String viewId>, <Integer pageIndex>, <Integer pageSize>)

Request parameters

Request Body

Parameter Name	Type	Description	Required
viewId	String	View ID	Y
pageIndex	Integer	Page number, starting from 1	Y
pageSize	Integer	Number of records per page	Y

Return Parameters

Parameter Name	Type	Description
displayFields	Array[object]	Defines field information displayed in the view
dataSet	Array[array]	Query result dataset

displayFields	object	Description
fieldName	String	Field display name
viewFieldId	String	View field ID
fieldId	String	Field ID

dataSet	Data Item	Description
formattedValue	String	Formatted value
formattedShowValue	String	Formatted display value
valueCode	String	Value code, may contain reference ID
value	String	Original value

Return an example

{
    "displayFields": [
        {
            "fieldName": "Customer Name",
            "viewFieldId": "BI_682ae4f89a6d0e000111052f",
            "fieldId": "BI_5bcebcddcab2980001ee22ab"
        },
        {
            "fieldName": "Order Amount",
            "viewFieldId": "BI_682ae4f99a6d0e0001110530",
            "fieldId": "BI_5bceda90dedd2c0001c2f54e"
        }
    ],
    "dataSet": [
        [
            {
                "formattedValue": "Multi-dimensional Fruit 1",
                "formattedShowValue": "Multi-dimensional Fruit 1",
                "valueCode": "Multi-dimensional Fruit 1$$60f14d96fd6db100011adaeb",
                "value": "Multi-dimensional Fruit 1"
            },
            {
                "formattedValue": "15.3K",
                "formattedShowValue": "15,300.00",
                "valueCode": "15300.0",
                "value": "15300.0"
            }
        ],
        [
            {
                "formattedValue": "Multi-dimensional Fruit 10",
                "formattedShowValue": "Multi-dimensional Fruit 10",
                "valueCode": "Multi-dimensional Fruit 10$$60f14d96fd6db100011adaf9",
                "value": "Multi-dimensional Fruit 10"
            },
            {
                "formattedValue": "15.39K",
                "formattedShowValue": "15,390.00",
                "valueCode": "15390.0",
                "value": "15390.0"
            }
        ]
    ]
}

Code examples

String viewId = "BI_682ae4f89a6d0e000111052e";
def (isErrorTmp, dataTmp, errorMsgTmp) = Fx.BI.pageLoadViewData(viewId, 1, 2)
if (!isErrorTmp) {
    log.info("Data: " + Fx.json.toJson(dataTmp))
} else {
    log.info("Query failed: " + errorMsgTmp)
}

Owner：翟付杰Jeffrey

6. queryViewData Chart Data Query

Chart Data Query

Fx.BI.queryViewData(<string viewId>, <string dashboardId>, <array filters>)

Request parameters

Request Body

Parameter Name	Type	Description	Required
viewId	string	View ID	Y
dashboardId	string	Dashboard ID	Y
filters	array[array]	List of query filter conditions	Y

filters	object	Description	Required
filterId	string	Filter ID	Y
value1	string	Filter condition value	Y

Return Parameters

Parameter Name	Type	Description
displayFields	Display Fields List[object]	Defines the field information displayed in the view
dataSet	Array[array]	Query result dataset

displayFields	object	Description
fieldName	String	Field display name
viewFieldId	String	View field ID
fieldId	String	Field ID

dataSet	Data Item	Description
formattedValue	String	Formatted value
formattedShowValue	String	Formatted display value
valueCode	String	Value code, may contain reference ID
value	String	Original value

Return an example

{
    "displayFields": [
        {
            "fieldName": "Customer Name",
            "viewFieldId": "BI_682ae4f89a6d0e000111052f",
            "fieldId": "BI_5bcebcddcab2980001ee22ab"
        },
        {
            "fieldName": "Order Amount",
            "viewFieldId": "BI_682ae4f99a6d0e0001110530",
            "fieldId": "BI_5bceda90dedd2c0001c2f54e"
        }
    ],
    "dataSet": [
        [
            {
                "formattedValue": "MultiD Fruit 1",
                "formattedShowValue": "MultiD Fruit 1",
                "valueCode": "MultiD Fruit 1$$60f14d96fd6db100011adaeb",
                "value": "MultiD Fruit 1"
            },
            {
                "formattedValue": "15.3K",
                "formattedShowValue": "15,300.00",
                "valueCode": "15300.0",
                "value": "15300.0"
            }
        ],
        [
            {
                "formattedValue": "MultiD Fruit 10",
                "formattedShowValue": "MultiD Fruit 10",
                "valueCode": "MultiD Fruit 10$$60f14d96fd6db100011adaf9",
                "value": "MultiD Fruit 10"
            },
            {
                "formattedValue": "15.39K",
                "formattedShowValue": "15,390.00",
                "valueCode": "15390.0",
                "value": "15390.0"
            }
        ]
    ]
}

Code examples

List filters = [["filterId":"BI_5f464863fd6d860001ee93da","value1":"Zhang San"]]
def(isError3,data3,errorMsg3) = Fx.BI.queryViewData("BI_5f27dc882cfb0a0001346786","BI_59a3e59333b39e09b44e9db1",filters)
if(!isError3){
  log.info("Pagination info:"+data3["page"])
  log.info("Header info:"+data3["displayFields"])
  log.info("Dataset:"+data3["dataSet"])
}else{
  log.info("Conditional query failed:"+errorMsg3)
}

Owner：翟付杰Jeffrey

7. pageQueryViewData Chart Data Query

Chart Data Query

Fx.BI.pageQueryViewData(<String viewId>, <String或null pageIndex>, <String或null pageSize>, <String objectId>, <String flag>, <Array filters>)

Request parameters

Request Body

Parameter Name	BI View Paginated Query	Paginated query for BI views based on conditions	Required
viewId	String	View ID, e.g.: BI_5f27dc882cfb0a0001346786	Y
pageIndex	String or null	Page index, can be null	--
pageSize	String or null	Number of records per page, can be null	--
objectId	String	Object ID, e.g.: BI_59a3e59333b39e09b44e9db1	Y
flag	String	Flag, e.g.: 1	Y
filters	Array[array]	Filter conditions list	Y

filters	object	Description	Required
filterId	String	Filter ID	Y
value1	String	Filter value 1	--
value2	String	Filter value 2 (used for range queries)	--
dateRangeId	Integer	Date range ID	--

Return Parameters

Parameter Name	BI View Display Data	Description
displayFields	Display Field List[object]	Defines the field information displayed in the view
dataSet	Data Set[array]	Query result dataset

displayFields	object	Description
fieldName	String	Field display name
viewFieldId	String	View field ID
fieldId	String	Field ID

dataSet	Data Item	Description
formattedValue	String	Formatted value
formattedShowValue	String	Formatted display value
valueCode	String	Value code, may contain reference ID
value	String	Raw value

Return an example

{
    "displayFields": [
        {
            "fieldName": "Customer Name",
            "viewFieldId": "BI_682ae4f89a6d0e000111052f",
            "fieldId": "BI_5bcebcddcab2980001ee22ab"
        },
        {
            "fieldName": "Order Amount",
            "viewFieldId": "BI_682ae4f99a6d0e0001110530",
            "fieldId": "BI_5bceda90dedd2c0001c2f54e"
        }
    ],
    "dataSet": [
        [
            {
                "formattedValue": "Multi-Dimensional Fruits 1",
                "formattedShowValue": "Multi-Dimensional Fruits 1",
                "valueCode": "Multi-Dimensional Fruits 1$$60f14d96fd6db100011adaeb",
                "value": "Multi-Dimensional Fruits 1"
            },
            {
                "formattedValue": "15.3K",
                "formattedShowValue": "15,300.00",
                "valueCode": "15300.0",
                "value": "15300.0"
            }
        ],
        [
            {
                "formattedValue": "Multi-Dimensional Fruits 10",
                "formattedShowValue": "Multi-Dimensional Fruits 10",
                "valueCode": "Multi-Dimensional Fruits 10$$60f14d96fd6db100011adaf9",
                "value": "Multi-Dimensional Fruits 10"
            },
            {
                "formattedValue": "15.39K",
                "formattedShowValue": "15,390.00",
                "valueCode": "15390.0",
                "value": "15390.0"
            }
        ]
    ]
}

Code examples

List filters = [["filterId":"BI_5f464863fd6d860001ee93da","value1":"Zhang San"]]
def(isError3,data3,errorMsg3) = Fx.BI.pageQueryViewData("BI_5f27dc882cfb0a0001346786",null,null,"BI_59a3e59333b39e09b44e9db1","1",filters)
if(!isError3){
  log.info("Pagination info:"+data3["page"])
  log.info("Header info:"+data3["displayFields"])
  log.info("Dataset:"+data3["dataSet"])
}else{
  log.info("Conditional query failed:"+errorMsg3)
}

Owner：翟付杰Jeffrey

8. queryPivotViewDataById Query data by chart viewId

Query data by chart viewId

Fx.BI.queryPivotViewDataById(<String viewId>)

Request parameters

Request Body

Parameter Name	Query by ID	Description	Required
viewId	String	View ID used to specify the target view for querying	Y

Return Parameters

Parameter Name	BI Dataset	Description
statFields	Array[Object]	Statistical field list
summaryDataSet	Object	Summary dataset
summaryDisplayFields	Array[Object]	Summary display field list
headerFields	Array[Array]	Header field list
colGroupFields	Array[Object]	Column grouping field list
page	Object	Pagination information
dataSet	Array[Array]	Dataset
rowGroupFields	Array[Object]	Row grouping field list

statFields	Object	Description
fieldName	String	Field display name
dbObjName	String	Database object name
crmObjName	String	CRM object name
dbFieldName	String	Database field name
fieldID	String	Field ID
crmFieldName	String	CRM field name

summaryDisplayFields	Object	Description
fieldName	String	Field display name
dbObjName	String	Database object name
crmObjName	String	CRM object name
dbFieldName	String	Database field name
fieldID	String	Field ID
crmFieldName	String	CRM field name

headerFields	Object	Description
fieldName	String	Field name
formattedValue	String	Formatted value
value	String	Raw value
fieldID	String	Field ID
formatStr	String	Format string
columnName	String	Column name

colGroupFields	Object	Description
formatStr	String	Format string
fieldName	String	Field name
fieldId	String	Field ID
columnName	String	Column name

page	Object	Pagination information
pageCount	Integer	Total page count
pageNumber	Integer	Current page number
pageSize	Integer	Records per page
totalCount	Integer	Total record count

dataSet	Object	Description
formattedValue	String	Formatted value
value	String	Raw value

rowGroupFields	Object	Description
formatStr	String	Format string
fieldName	String	Field name
fieldId	String	Field ID
columnName	String	Column name

Return an example

{
    "statFields": [
        {
            "fieldName": "Amount",
            "dbObjName": "object_oz2i0__c",
            "crmObjName": "object_oz2i0__c",
            "dbFieldName": "field_6rfqC__c",
            "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
            "crmFieldName": "field_6rfqC__c"
        }
    ],
    "summaryDataSet": {
        "object_oz2i0__c_field_6rfqc__c$0": [
            {
                "aggTypeCaption": "Sum",
                "aggType": "2",
                "formattedValue": "10.000",
                "formattedShowValue": "10.000",
                "value": "10.0"
            }
        ]
    },
    "summaryDisplayFields": [
        {
            "fieldName": "Amount",
            "dbObjName": "object_oz2i0__c",
            "crmObjName": "object_oz2i0__c",
            "dbFieldName": "field_6rfqC__c",
            "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
            "crmFieldName": "field_6rfqC__c"
        }
    ],
    "headerFields": [
        [
            {
                "fieldName": "Department",
                "formattedValue": "",
                "value": "",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            },
            {
                "formatStr": "",
                "fieldName": "Department",
                "value": "Department",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf",
                "columnName": "object_oz2i0__c_field_6ejpc__c$0"
            },
            {
                "fieldName": "Sales Department",
                "formattedValue": "Sales Department",
                "value": "1001",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            },
            {
                "fieldName": "Total",
                "formattedValue": "Total",
                "value": "Total",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            }
        ],
        [
            {
                "formatStr": "",
                "fieldName": "Owner's Primary Department",
                "value": "Owner's Primary Department",
                "fieldID": "BI_a068e508be76af5026880cbde60a8610",
                "columnName": "object_oz2i0__c_owner_department$0"
            },
            {
                "formatStr": "",
                "fieldName": "Customer Name",
                "value": "Customer Name",
                "fieldID": "BI_3f378638510641067008767e02cf6563",
                "columnName": "object_oz2i0__c_field_21fnw__c$0"
            },
            {
                "formatStr": "#,##0.000",
                "fieldName": "Amount (Sum)",
                "value": "Amount",
                "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
                "columnName": "object_oz2i0__c_field_6rfqc__c$0"
            },
            {
                "formatStr": "#,##0.000",
                "fieldName": "Amount (Sum)",
                "value": "Amount",
                "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
                "columnName": "object_oz2i0__c_field_6rfqc__c$0"
            }
        ]
    ],
    "colGroupFields": [
        {
            "formatStr": "",
            "fieldName": "Owner's Primary Department",
            "fieldId": "BI_a068e508be76af5026880cbde60a8610",
            "columnName": "object_oz2i0__c_owner_department$0"
        },
        {
            "formatStr": "",
            "fieldName": "Customer Name",
            "fieldId": "BI_3f378638510641067008767e02cf6563",
            "columnName": "object_oz2i0__c_field_21fnw__c$0"
        }
    ],
    "page": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 20,
        "totalCount": 3
    },
    "dataSet": [
        [
            {
                "formattedValue": "CN-Department A1",
                "value": "1002"
            },
            {
                "formattedValue": "--",
                "value": "--"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ],
        [
            {
                "formattedValue": "CN-Department A1",
                "value": "1002"
            },
            {
                "formattedValue": "Subtotal",
                "value": "Subtotal"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ],
        [
            {
                "formattedValue": "Total",
                "value": "Total"
            },
            {
                "formattedValue": "Total",
                "value": "Total"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ]
    ],
    "rowGroupFields": [
        {
            "formatStr": "",
            "fieldName": "Department",
            "fieldId": "BI_1416823ffb7298cc11838cedb4b59fdf",
            "columnName": "object_oz2i0__c_field_6ejpc__c$0"
        }
    ]
}

Code examples

// Query pivot table by viewId
def (isError, data, errorMsg) = Fx.BI.queryPivotViewDataById("BI_62973467376efe000172be38")
if (!isError) {
    log.info("Pagination info:" + data["page"])
    log.info("Header fields:" + data["headerFields"])
    log.info("Dataset:" + data["dataSet"])
    log.info("Column grouping:" + data["colGroupFields"])
    log.info("Row grouping:" + data["rowGroupFields"])
    log.info("Statistical columns:" + data["statFields"])
    log.info("Summary dataset:" + data["summaryDataSet"])
    log.info("Summary display fields:" + data["summaryDisplayFields"])
} else {
    log.info("Query failed:" + errorMsg)
}

Owner：翟付杰Jeffrey

9. queryPivotViewDataByPage Query data by chart ID with custom pagination

Query data by chart ID and custom pagination

Fx.BI.queryPivotViewDataByPage(<String viewId>, <Integer pageIndex>, <Integer pageSize>)

Request parameters

Request Body

Parameter Name	BI Crosstab Pagination Query Parameters	Description	Required
viewId	String	View ID	Y
pageIndex	Integer	Page number (starting from 1)	Y
pageSize	Integer	Number of records per page	Y

Return Parameters

Parameter Name	BI Dataset Result	Description
statFields	Array[Object]	List of statistical fields
summaryDataSet	Object	Summary dataset
summaryDisplayFields	Array[Object]	List of summary display fields
headerFields	Array[Array]	List of header fields
colGroupFields	Array[Object]	List of column grouping fields
page	Object	Pagination information
dataSet	Array[Array]	Dataset
rowGroupFields	Array[Object]	List of row grouping fields

statFields	Object	Description
fieldName	String	Field display name
dbObjName	String	Database object name
crmObjName	String	CRM object name
dbFieldName	String	Database field name
fieldID	String	Field ID
crmFieldName	String	CRM field name

summaryDisplayFields	Object	Description
fieldName	String	Field display name
dbObjName	String	Database object name
crmObjName	String	CRM object name
dbFieldName	String	Database field name
fieldID	String	Field ID
crmFieldName	String	CRM field name

headerFields	Object	Description
fieldName	String	Field name
formattedValue	String	Formatted value
value	String	Raw value
fieldID	String	Field ID
formatStr	String	Format string
columnName	String	Column name

colGroupFields	Object	Description
formatStr	String	Format string
fieldName	String	Field name
fieldId	String	Field ID
columnName	String	Column name

page	Object	Pagination information
pageCount	Integer	Total page count
pageNumber	Integer	Current page number
pageSize	Integer	Records per page
totalCount	Integer	Total record count

dataSet	Object	Description
formattedValue	String	Formatted value
value	String	Raw value

rowGroupFields	Object	Description
formatStr	String	Format string
fieldName	String	Field name
fieldId	String	Field ID
columnName	String	Column name

Return an example

{
    "statFields": [
        {
            "fieldName": "Amount",
            "dbObjName": "object_oz2i0__c",
            "crmObjName": "object_oz2i0__c",
            "dbFieldName": "field_6rfqC__c",
            "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
            "crmFieldName": "field_6rfqC__c"
        }
    ],
    "summaryDataSet": {
        "object_oz2i0__c_field_6rfqc__c$0": [
            {
                "aggTypeCaption": "Sum",
                "aggType": "2",
                "formattedValue": "10.000",
                "formattedShowValue": "10.000",
                "value": "10.0"
            }
        ]
    },
    "summaryDisplayFields": [
        {
            "fieldName": "Amount",
            "dbObjName": "object_oz2i0__c",
            "crmObjName": "object_oz2i0__c",
            "dbFieldName": "field_6rfqC__c",
            "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
            "crmFieldName": "field_6rfqC__c"
        }
    ],
    "headerFields": [
        [
            {
                "fieldName": "Department",
                "formattedValue": "",
                "value": "",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            },
            {
                "formatStr": "",
                "fieldName": "Department",
                "value": "Department",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf",
                "columnName": "object_oz2i0__c_field_6ejpc__c$0"
            },
            {
                "fieldName": "Sales Department",
                "formattedValue": "Sales Department",
                "value": "1001",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            },
            {
                "fieldName": "Total",
                "formattedValue": "Total",
                "value": "Total",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            }
        ],
        [
            {
                "formatStr": "",
                "fieldName": "Owner's Primary Department",
                "value": "Owner's Primary Department",
                "fieldID": "BI_a068e508be76af5026880cbde60a8610",
                "columnName": "object_oz2i0__c_owner_department$0"
            },
            {
                "formatStr": "",
                "fieldName": "Customer Name",
                "value": "Customer Name",
                "fieldID": "BI_3f378638510641067008767e02cf6563",
                "columnName": "object_oz2i0__c_field_21fnw__c$0"
            },
            {
                "formatStr": "#,##0.000",
                "fieldName": "Amount (Sum)",
                "value": "Amount",
                "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
                "columnName": "object_oz2i0__c_field_6rfqc__c$0"
            },
            {
                "formatStr": "#,##0.000",
                "fieldName": "Amount (Sum)",
                "value": "Amount",
                "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
                "columnName": "object_oz2i0__c_field_6rfqc__c$0"
            }
        ]
    ],
    "colGroupFields": [
        {
            "formatStr": "",
            "fieldName": "Owner's Primary Department",
            "fieldId": "BI_a068e508be76af5026880cbde60a8610",
            "columnName": "object_oz2i0__c_owner_department$0"
        },
        {
            "formatStr": "",
            "fieldName": "Customer Name",
            "fieldId": "BI_3f378638510641067008767e02cf6563",
            "columnName": "object_oz2i0__c_field_21fnw__c$0"
        }
    ],
    "page": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 20,
        "totalCount": 3
    },
    "dataSet": [
        [
            {
                "formattedValue": "CN-Department A1",
                "value": "1002"
            },
            {
                "formattedValue": "--",
                "value": "--"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ],
        [
            {
                "formattedValue": "CN-Department A1",
                "value": "1002"
            },
            {
                "formattedValue": "Subtotal",
                "value": "Subtotal"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ],
        [
            {
                "formattedValue": "Total",
                "value": "Total"
            },
            {
                "formattedValue": "Total",
                "value": "Total"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ]
    ],
    "rowGroupFields": [
        {
            "formatStr": "",
            "fieldName": "Department",
            "fieldId": "BI_1416823ffb7298cc11838cedb4b59fdf",
            "columnName": "object_oz2i0__c_field_6ejpc__c$0"
        }
    ]
}

Code examples

// Query pivot table data by viewId and pagination info
def (isError, data, errorMsg) = Fx.BI.queryPivotViewDataByPage("BI_62973467376efe000172be38", 1, 1)
if (!isError) {
    log.info("Pagination info:" + data["page"])
    log.info("Header fields:" + data["headerFields"])
    log.info("Dataset:" + data["dataSet"])
    log.info("Column grouping fields:" + data["colGroupFields"])
    log.info("Row grouping fields:" + data["rowGroupFields"])
    log.info("Statistical columns:" + data["statFields"])
    log.info("Summary dataset:" + data["summaryDataSet"])
    log.info("Summary display fields:" + data["summaryDisplayFields"])
} else {
    log.info("Query failed:" + errorMsg)
}

Owner：翟付杰Jeffrey

10. queryPivotViewDataByFilter Query data by scenario and filter

Querying Data by Scenarios and Filters

Fx.BI.queryPivotViewDataByFilter(<String viewId>, <String optionId>, <Array filters>)

Request parameters

Request Body

Parameter Name	BI Cross Report Filter Query Parameters	Description	Required
viewId	String	View ID	Y
optionId	String	Scenario ID	Y
filters	Array[Array]	Filter conditions list	Y

filters	Object	Description	Required
filterId	String	Filter ID	Y
value1	String	Filter value 1, typically a JSON string	Y
value2	String	Filter value 2, typically used for end date in date ranges	Y

Return Parameters

Parameter Name	BI Dataset	Description
statFields	Array[Object]	List of statistical fields
summaryDataSet	Object	Aggregated dataset
summaryDisplayFields	Array[Object]	List of aggregated display fields
headerFields	Array[Array]	List of header fields
colGroupFields	Array[Object]	List of column grouping fields
page	Object	Pagination information
dataSet	Array[Array]	Dataset
rowGroupFields	Array[Object]	List of row grouping fields

statFields	Object	Description
fieldName	String	Field display name
dbObjName	String	Database object name
crmObjName	String	CRM object name
dbFieldName	String	Database field name
fieldID	String	Field ID
crmFieldName	String	CRM field name

summaryDisplayFields	Object	Description
fieldName	String	Field display name
dbObjName	String	Database object name
crmObjName	String	CRM object name
dbFieldName	String	Database field name
fieldID	String	Field ID
crmFieldName	String	CRM field name

headerFields	Object	Description
fieldName	String	Field name
formattedValue	String	Formatted value
value	String	Raw value
fieldID	String	Field ID
formatStr	String	Format string
columnName	String	Column name

colGroupFields	Object	Description
formatStr	String	Format string
fieldName	String	Field name
fieldId	String	Field ID
columnName	String	Column name

page	Object	Pagination information
pageCount	Integer	Total page count
pageNumber	Integer	Current page number
pageSize	Integer	Records per page
totalCount	Integer	Total record count

dataSet	Object	Description
formattedValue	String	Formatted value
value	String	Raw value

rowGroupFields	Object	Description
formatStr	String	Format string
fieldName	String	Field name
fieldId	String	Field ID
columnName	String	Column name

Return an example

{
    "statFields": [
        {
            "fieldName": "Amount",
            "dbObjName": "object_oz2i0__c",
            "crmObjName": "object_oz2i0__c",
            "dbFieldName": "field_6rfqC__c",
            "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
            "crmFieldName": "field_6rfqC__c"
        }
    ],
    "summaryDataSet": {
        "object_oz2i0__c_field_6rfqc__c$0": [
            {
                "aggTypeCaption": "Sum",
                "aggType": "2",
                "formattedValue": "10.000",
                "formattedShowValue": "10.000",
                "value": "10.0"
            }
        ]
    },
    "summaryDisplayFields": [
        {
            "fieldName": "Amount",
            "dbObjName": "object_oz2i0__c",
            "crmObjName": "object_oz2i0__c",
            "dbFieldName": "field_6rfqC__c",
            "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
            "crmFieldName": "field_6rfqC__c"
        }
    ],
    "headerFields": [
        [
            {
                "fieldName": "Department",
                "formattedValue": "",
                "value": "",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            },
            {
                "formatStr": "",
                "fieldName": "Department",
                "value": "Department",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf",
                "columnName": "object_oz2i0__c_field_6ejpc__c$0"
            },
            {
                "fieldName": "Sales Department",
                "formattedValue": "Sales Department",
                "value": "1001",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            },
            {
                "fieldName": "Total",
                "formattedValue": "Total",
                "value": "Total",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            }
        ],
        [
            {
                "formatStr": "",
                "fieldName": "Owner's Primary Department",
                "value": "Owner's Primary Department",
                "fieldID": "BI_a068e508be76af5026880cbde60a8610",
                "columnName": "object_oz2i0__c_owner_department$0"
            },
            {
                "formatStr": "",
                "fieldName": "Customer Name",
                "value": "Customer Name",
                "fieldID": "BI_3f378638510641067008767e02cf6563",
                "columnName": "object_oz2i0__c_field_21fnw__c$0"
            },
            {
                "formatStr": "#,##0.000",
                "fieldName": "Amount (Sum)",
                "value": "Amount",
                "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
                "columnName": "object_oz2i0__c_field_6rfqc__c$0"
            },
            {
                "formatStr": "#,##0.000",
                "fieldName": "Amount (Sum)",
                "value": "Amount",
                "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
                "columnName": "object_oz2i0__c_field_6rfqc__c$0"
            }
        ]
    ],
    "colGroupFields": [
        {
            "formatStr": "",
            "fieldName": "Owner's Primary Department",
            "fieldId": "BI_a068e508be76af5026880cbde60a8610",
            "columnName": "object_oz2i0__c_owner_department$0"
        },
        {
            "formatStr": "",
            "fieldName": "Customer Name",
            "fieldId": "BI_3f378638510641067008767e02cf6563",
            "columnName": "object_oz2i0__c_field_21fnw__c$0"
        }
    ],
    "page": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 20,
        "totalCount": 3
    },
    "dataSet": [
        [
            {
                "formattedValue": "CN-Department A1",
                "value": "1002"
            },
            {
                "formattedValue": "--",
                "value": "--"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ],
        [
            {
                "formattedValue": "CN-Department A1",
                "value": "1002"
            },
            {
                "formattedValue": "Subtotal",
                "value": "Subtotal"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ],
        [
            {
                "formattedValue": "Total",
                "value": "Total"
            },
            {
                "formattedValue": "Total",
                "value": "Total"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ]
    ],
    "rowGroupFields": [
        {
            "formatStr": "",
            "fieldName": "Department",
            "fieldId": "BI_1416823ffb7298cc11838cedb4b59fdf",
            "columnName": "object_oz2i0__c_field_6ejpc__c$0"
        }
    ]
}

Code examples

// Query pivot table data by viewId, filters, and defaultFilterOptionId  
List filters = [["filterId": "BI_62c68112deef7b0001c1f756", "value1": "[{\"id\":1001,\"type\":\"g\"}]", "value2": ""]]  
def (isError, data, errorMsg) = Fx.BI.queryPivotViewDataByFilter("BI_62973467376efe000172be38", "BI_59a3e59333b39e09b44e9db2", filters)  
if (!isError) {  
    log.info("Pagination info:" + data["page"])  
    log.info("Header fields:" + data["headerFields"])  
    log.info("Dataset:" + data["dataSet"])  
    log.info("Column grouping:" + data["colGroupFields"])  
    log.info("Row grouping:" + data["rowGroupFields"])  
    log.info("Statistical columns:" + data["statFields"])  
    log.info("Summary dataset:" + data["summaryDataSet"])  
    log.info("Summary display fields:" + data["summaryDisplayFields"])  
} else {  
    log.info("Query failed:" + errorMsg)  
}

Owner：翟付杰Jeffrey

11. queryPivotReportData Pivot Table Data Query

Cross-tabular data query

Fx.BI.queryPivotReportData(<String reportId>, <Integer pageIndex>, <Integer pageSize>, <String optionId>, <Array filters>)

Request parameters

Request Body

Parameter Name	BI Crosstab Report Query Parameters	Description	Required
reportId	String	Report ID	Y
pageIndex	Integer	Page number (starting from 1)	Y
pageSize	Integer	Number of records per page	Y
optionId	String	Option ID	Y
filters	Array[Array]	Filter conditions list	Y

filters	Object	Description	Required
filterId	String	Filter ID	Y
value1	String	Filter value 1 (typically a JSON string)	Y
value2	String	Filter value 2 (typically used for end date in date ranges)	Y

Return Parameters

Parameter Name	BI Dataset	Description
statFields	Array[Object]	List of statistical fields
summaryDataSet	Object	Summary dataset
summaryDisplayFields	Array[Object]	List of summary display fields
headerFields	Array[Array]	List of header fields
colGroupFields	Array[Object]	List of column grouping fields
page	Object	Pagination information
dataSet	Array[Array]	Dataset
rowGroupFields	Array[Object]	List of row grouping fields

statFields	Object	Description
fieldName	String	Field display name
dbObjName	String	Database object name
crmObjName	String	CRM object name
dbFieldName	String	Database field name
fieldID	String	Field ID
crmFieldName	String	CRM field name

summaryDisplayFields	Object	Description
fieldName	String	Field display name
dbObjName	String	Database object name
crmObjName	String	CRM object name
dbFieldName	String	Database field name
fieldID	String	Field ID
crmFieldName	String	CRM field name

headerFields	Object	Description
fieldName	String	Field name
formattedValue	String	Formatted value
value	String	Raw value
fieldID	String	Field ID
formatStr	String	Format string
columnName	String	Column name

colGroupFields	Object	Description
formatStr	String	Format string
fieldName	String	Field name
fieldId	String	Field ID
columnName	String	Column name

page	Object	Pagination information
pageCount	Integer	Total page count
pageNumber	Integer	Current page number
pageSize	Integer	Records per page
totalCount	Integer	Total record count

dataSet	Object	Description
formattedValue	String	Formatted value
value	String	Raw value

rowGroupFields	Object	Description
formatStr	String	Format string
fieldName	String	Field name
fieldId	String	Field ID
columnName	String	Column name

Return an example

{
    "statFields": [
        {
            "fieldName": "Amount",
            "dbObjName": "object_oz2i0__c",
            "crmObjName": "object_oz2i0__c",
            "dbFieldName": "field_6rfqC__c",
            "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
            "crmFieldName": "field_6rfqC__c"
        }
    ],
    "summaryDataSet": {
        "object_oz2i0__c_field_6rfqc__c$0": [
            {
                "aggTypeCaption": "Sum",
                "aggType": "2",
                "formattedValue": "10.000",
                "formattedShowValue": "10.000",
                "value": "10.0"
            }
        ]
    },
    "summaryDisplayFields": [
        {
            "fieldName": "Amount",
            "dbObjName": "object_oz2i0__c",
            "crmObjName": "object_oz2i0__c",
            "dbFieldName": "field_6rfqC__c",
            "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
            "crmFieldName": "field_6rfqC__c"
        }
    ],
    "headerFields": [
        [
            {
                "fieldName": "Department",
                "formattedValue": "",
                "value": "",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            },
            {
                "formatStr": "",
                "fieldName": "Department",
                "value": "Department",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf",
                "columnName": "object_oz2i0__c_field_6ejpc__c$0"
            },
            {
                "fieldName": "Sales Department",
                "formattedValue": "Sales Department",
                "value": "1001",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            },
            {
                "fieldName": "Total",
                "formattedValue": "Total",
                "value": "Total",
                "fieldID": "BI_1416823ffb7298cc11838cedb4b59fdf"
            }
        ],
        [
            {
                "formatStr": "",
                "fieldName": "Owner's Primary Department",
                "value": "Owner's Primary Department",
                "fieldID": "BI_a068e508be76af5026880cbde60a8610",
                "columnName": "object_oz2i0__c_owner_department$0"
            },
            {
                "formatStr": "",
                "fieldName": "Customer Name",
                "value": "Customer Name",
                "fieldID": "BI_3f378638510641067008767e02cf6563",
                "columnName": "object_oz2i0__c_field_21fnw__c$0"
            },
            {
                "formatStr": "#,##0.000",
                "fieldName": "Amount (Sum)",
                "value": "Amount",
                "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
                "columnName": "object_oz2i0__c_field_6rfqc__c$0"
            },
            {
                "formatStr": "#,##0.000",
                "fieldName": "Amount (Sum)",
                "value": "Amount",
                "fieldID": "BI_0f46eb539465b5746c1798ad9789c83a",
                "columnName": "object_oz2i0__c_field_6rfqc__c$0"
            }
        ]
    ],
    "colGroupFields": [
        {
            "formatStr": "",
            "fieldName": "Owner's Primary Department",
            "fieldId": "BI_a068e508be76af5026880cbde60a8610",
            "columnName": "object_oz2i0__c_owner_department$0"
        },
        {
            "formatStr": "",
            "fieldName": "Customer Name",
            "fieldId": "BI_3f378638510641067008767e02cf6563",
            "columnName": "object_oz2i0__c_field_21fnw__c$0"
        }
    ],
    "page": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 20,
        "totalCount": 3
    },
    "dataSet": [
        [
            {
                "formattedValue": "CN-Department A1",
                "value": "1002"
            },
            {
                "formattedValue": "--",
                "value": "--"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ],
        [
            {
                "formattedValue": "CN-Department A1",
                "value": "1002"
            },
            {
                "formattedValue": "Subtotal",
                "value": "Subtotal"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ],
        [
            {
                "formattedValue": "Total",
                "value": "Total"
            },
            {
                "formattedValue": "Total",
                "value": "Total"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            },
            {
                "formattedValue": "10.000",
                "value": "10.0"
            }
        ]
    ],
    "rowGroupFields": [
        {
            "formatStr": "",
            "fieldName": "Department",
            "fieldId": "BI_1416823ffb7298cc11838cedb4b59fdf",
            "columnName": "object_oz2i0__c_field_6ejpc__c$0"
        }
    ]
}

Code examples

List filters = [["filterId": "BI_62c68112deef7b0001c1f756", "value1": "[{\"id\":1001,\"type\":\"g\"}]", "value2": ""]]
def (isError, data, errorMsg) = Fx.BI.queryPivotReportData("BI_62973467376efe000172be38", 1, 1, "BI_59a3e59333b39e09b44e9db2", filters)
if (!isError) {
    log.info("Pagination info:" + data["page"])
    log.info("Header fields:" + data["headerFields"])
    log.info("Dataset:" + data["dataSet"])
    log.info("Column grouping:" + data["colGroupFields"])
    log.info("Row grouping:" + data["rowGroupFields"])
    log.info("Statistical columns:" + data["statFields"])
    log.info("summaryDataSet:" + data["summaryDataSet"])
    log.info("summaryDisplayFields:" + data["summaryDisplayFields"])
} else {
    log.info("Query failed:" + errorMsg)
}

Owner：翟付杰Jeffrey

12. queryLwtViewData Composite Table Data Query

Table Data Query

Fx.BI.queryLwtViewData(<String viewId>, <Integer pageNumber>, <Integer pageSize>, <Array filterList>)

Request parameters

Request Body

Parameter Name	BI View Paginated Query with Filters	Description	Required
viewId	String	View ID specifying the target view for query	Y
pageNumber	Integer	Page number starting from 1	Y
pageSize	Integer	Number of records per page	Y
filterList	Array[array]	List of filter conditions	Y

filterList	Filter Condition	Description	Required
filterId	String	Filter ID	Y
value1	String	Filter value 1	--
value2	String	Filter value 2 (used for range queries)	--
dateRangeId	Integer	Date range ID	--

Return Parameters

Parameter Name	object	Description
page	Type
displayFields	Type[array]
dataSet	array[array]

page	Type	Description
pageCount	Integer	Total number of pages
pageNumber	Integer	Currently displayed page number
pageSize	Integer	Number of records displayed per page
totalCount	Integer	Total number of records in the dataset

displayFields	object	Description
fieldName	String	Column header name
objName	String	Object name
dbFieldName	String	Field API name
fieldType	String	Field type
columnKey	String	Unique identifier
fieldId	String	Field ID
refObjName	String	Related object API name

dataSet	Type	Description
displayValue	String	Displayed data value
value	String	Actual data value
dataFormatStr	String	Data format string
valueCode	String	Data value code

Return an example

{
    "page": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 20,
        "totalCount": 11
    },
    "displayFields": [
        [
            {
                "fieldName": "Primary Attribute",
                "objName": "Guagua",
                "dbFieldName": "name",
                "fieldType": "String",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.bJO7v.Label",
                "fieldId": "BI_61946d085af9d7000104f81c"
            },
            {
                "fieldName": "Creation Time",
                "objName": "Guagua",
                "dbFieldName": "create_time",
                "fieldType": "Date",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.FyMmk.Label",
                "fieldId": "BI_61946d085af9d7000104f82b"
            },
            {
                "refObjName": "org_employee_user",
                "fieldName": "Creator",
                "objName": "Guagua",
                "dbFieldName": "created_by",
                "fieldType": "Circle",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.5KE7p.Label",
                "fieldId": "BI_61946d085af9d7000104f84a"
            },
            {
                "fieldName": "Number (Sum)",
                "objName": "Guagua",
                "dbFieldName": "field_LKyOt__c",
                "fieldType": "Number",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.K4TdN.Label",
                "fieldId": "BI_bb08fc7d10b7035b8dce074e4eedf"
            },
            {
                "fieldName": "Primary Attribute (Unique Count)",
                "objName": "Guagua",
                "dbFieldName": "name",
                "fieldType": "Number",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.FRgFG.Label",
                "fieldId": "BI_61946d085af9d7000104f81a"
            }
        ]
    ],
    "dataSet": [
        [
            {
                "displayValue": "20250324-1",
                "value": "20250324-1$$67e0d9e27258120007546170",
                "dataFormatStr": ""
            },
            {
                "displayValue": "20250324",
                "value": "20250324",
                "dataFormatStr": ""
            },
            {
                "displayValue": "CN-gua",
                "value": "1198",
                "dataFormatStr": ""
            },
            {
                "displayValue": "193M",
                "value": "192500000.00000000",
                "dataFormatStr": ""
            },
            {
                "displayValue": "1",
                "valueCode": "1044g",
                "value": "1.00000000",
                "dataFormatStr": ""
            }
        ],
        [
            {
                "displayValue": "20250324-2",
                "value": "20250324-2$$67e0fbde7258120007557c6e",
                "dataFormatStr": ""
            },
            {
                "displayValue": "20250324",
                "value": "20250324",
                "dataFormatStr": ""
            },
            {
                "displayValue": "CN-gua",
                "value": "1198",
                "dataFormatStr": ""
            },
            {
                "displayValue": "193M",
                "value": "192500000.00000000",
                "dataFormatStr": ""
            },
            {
                "displayValue": "1",
                "valueCode": "1044g",
                "value": "1.00000000",
                "dataFormatStr": ""
            }
        ]
    ]
}

Code examples

List filterList = [["filterId": "BI_62cb8af6741ac20001debf72", "value1": "", "value2": "", "dateRangeId": 6]];
def (isError, data, errorMsg) = Fx.BI.queryLwtViewData("BI_lwt_1657506871248", 1, 1, filterList)
if (!isError) {
    log.info("Pagination info:" + data["page"])
    log.info("Header info:" + data["displayFields"])
    log.info("Dataset:" + data["dataSet"])
} else {
    log.info("Query failed:" + errorMsg)
}

Owner：翟付杰Jeffrey

13. queryLwtViewDataById Query chart data by viewId

Query data by chart viewId

Fx.BI.queryLwtViewDataById(<String viewId>)

Request parameters

Request Body

Parameter Name	Type	Description	Required
viewId	String	View ID used to specify the view to be queried	Y

Return Parameters

Parameter Name	object	Description
page	Type
displayFields	Type[array]
dataSet	array[array]

page	Type	Description
pageCount	Integer	Total number of pages
pageNumber	Integer	Current page number being displayed
pageSize	Integer	Number of records displayed per page
totalCount	Integer	Total number of records in the dataset

displayFields	object	Description
fieldName	String	Column header name
objName	String	Object name
dbFieldName	String	Field API name
fieldType	String	Field type
columnKey	String	Unique identifier
fieldId	String	Field ID
refObjName	String	Related object API name

dataSet	Type	Description
displayValue	String	Data value for display purposes
value	String	Actual data value
dataFormatStr	String	Data format string
valueCode	String	Data value code

Return an example

{
    "page": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 20,
        "totalCount": 11
    },
    "displayFields": [
        [
            {
                "fieldName": "Primary Attribute",
                "objName": "GuaGua",
                "dbFieldName": "name",
                "fieldType": "String",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.bJO7v.Label",
                "fieldId": "BI_61946d085af9d7000104f81c"
            },
            {
                "fieldName": "Creation Time",
                "objName": "GuaGua",
                "dbFieldName": "create_time",
                "fieldType": "Date",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.FyMmk.Label",
                "fieldId": "BI_61946d085af9d7000104f82b"
            },
            {
                "refObjName": "org_employee_user",
                "fieldName": "Creator",
                "objName": "GuaGua",
                "dbFieldName": "created_by",
                "fieldType": "Circle",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.5KE7p.Label",
                "fieldId": "BI_61946d085af9d7000104f84a"
            },
            {
                "fieldName": "Number (Sum)",
                "objName": "GuaGua",
                "dbFieldName": "field_LKyOt__c",
                "fieldType": "Number",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.K4TdN.Label",
                "fieldId": "BI_bb08fc7d10b7035b8dce074e4eedf"
            },
            {
                "fieldName": "Primary Attribute (Unique Count)",
                "objName": "GuaGua",
                "dbFieldName": "name",
                "fieldType": "Number",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.FRgFG.Label",
                "fieldId": "BI_61946d085af9d7000104f81a"
            }
        ]
    ],
    "dataSet": [
        [
            {
                "displayValue": "20250324-1",
                "value": "20250324-1$$67e0d9e27258120007546170",
                "dataFormatStr": ""
            },
            {
                "displayValue": "20250324",
                "value": "20250324",
                "dataFormatStr": ""
            },
            {
                "displayValue": "CN-gua",
                "value": "1198",
                "dataFormatStr": ""
            },
            {
                "displayValue": "193M",
                "value": "192500000.00000000",
                "dataFormatStr": ""
            },
            {
                "displayValue": "1",
                "valueCode": "1044g",
                "value": "1.00000000",
                "dataFormatStr": ""
            }
        ],
        [
            {
                "displayValue": "20250324-2",
                "value": "20250324-2$$67e0fbde7258120007557c6e",
                "dataFormatStr": ""
            },
            {
                "displayValue": "20250324",
                "value": "20250324",
                "dataFormatStr": ""
            },
            {
                "displayValue": "CN-gua",
                "value": "1198",
                "dataFormatStr": ""
            },
            {
                "displayValue": "193M",
                "value": "192500000.00000000",
                "dataFormatStr": ""
            },
            {
                "displayValue": "1",
                "valueCode": "1044g",
                "value": "1.00000000",
                "dataFormatStr": ""
            }
        ]
    ]
}

Code examples

def (isError, data, errorMsg) = Fx.BI.queryLwtViewDataById("BI_lwt_1657506871248")
if (!isError) {
    log.info("Pagination info:" + data["page"])
    log.info("Header info:" + data["displayFields"])
    log.info("Dataset:" + data["dataSet"])
} else {
    log.info("Query failed:" + errorMsg)
}

Owner：翟付杰Jeffrey

14. queryLwtViewDataByPage Query data by chart ID with custom pagination

Retrieve data by chart ID with custom pagination

Fx.BI.queryLwtViewDataByPage(<String viewId>, <Integer pageNumber>, <Integer pageSize>)

Request parameters

Request Body

Parameter Name	BI View Pagination Query	Description	Required
viewId	String	View ID, used to specify the target view for query	Y
pageNumber	Integer	Page number, starting from 1	Y
pageSize	Integer	Number of records per page	Y

Return Parameters

Parameter Name	object	Description
page	Type
displayFields	Type[array]
dataSet	array[array]

page	Type	Description
pageCount	Integer	Total number of pages
pageNumber	Integer	Currently displayed page number
pageSize	Integer	Number of records displayed per page
totalCount	Integer	Total number of records in the dataset

displayFields	object	Description
fieldName	String	Column header name
objName	String	Object name
dbFieldName	String	Field API name
fieldType	String	Field type
columnKey	String	Unique identifier
fieldId	String	Field ID
refObjName	String	Related object API name

dataSet	Type	Description
displayValue	String	Data value for display
value	String	Actual data value
dataFormatStr	String	Data format string
valueCode	String	Data value code

Return an example

{
    "page": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 20,
        "totalCount": 11
    },
    "displayFields": [
        [
            {
                "fieldName": "Primary Attribute",
                "objName": "GuaGua",
                "dbFieldName": "name",
                "fieldType": "String",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.bJO7v.Label",
                "fieldId": "BI_61946d085af9d7000104f81c"
            },
            {
                "fieldName": "Creation Time",
                "objName": "GuaGua",
                "dbFieldName": "create_time",
                "fieldType": "Date",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.FyMmk.Label",
                "fieldId": "BI_61946d085af9d7000104f82b"
            },
            {
                "refObjName": "org_employee_user",
                "fieldName": "Creator",
                "objName": "GuaGua",
                "dbFieldName": "created_by",
                "fieldType": "Circle",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.5KE7p.Label",
                "fieldId": "BI_61946d085af9d7000104f84a"
            },
            {
                "fieldName": "Number (Sum)",
                "objName": "GuaGua",
                "dbFieldName": "field_LKyOt__c",
                "fieldType": "Number",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.K4TdN.Label",
                "fieldId": "BI_bb08fc7d10b7035b8dce074e4eedf"
            },
            {
                "fieldName": "Primary Attribute (Unique Count)",
                "objName": "GuaGua",
                "dbFieldName": "name",
                "fieldType": "Number",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.FRgFG.Label",
                "fieldId": "BI_61946d085af9d7000104f81a"
            }
        ]
    ],
    "dataSet": [
        [
            {
                "displayValue": "20250324-1",
                "value": "20250324-1$$67e0d9e27258120007546170",
                "dataFormatStr": ""
            },
            {
                "displayValue": "20250324",
                "value": "20250324",
                "dataFormatStr": ""
            },
            {
                "displayValue": "CN-gua",
                "value": "1198",
                "dataFormatStr": ""
            },
            {
                "displayValue": "193M",
                "value": "192500000.00000000",
                "dataFormatStr": ""
            },
            {
                "displayValue": "1",
                "valueCode": "1044g",
                "value": "1.00000000",
                "dataFormatStr": ""
            }
        ],
        [
            {
                "displayValue": "20250324-2",
                "value": "20250324-2$$67e0fbde7258120007557c6e",
                "dataFormatStr": ""
            },
            {
                "displayValue": "20250324",
                "value": "20250324",
                "dataFormatStr": ""
            },
            {
                "displayValue": "CN-gua",
                "value": "1198",
                "dataFormatStr": ""
            },
            {
                "displayValue": "193M",
                "value": "192500000.00000000",
                "dataFormatStr": ""
            },
            {
                "displayValue": "1",
                "valueCode": "1044g",
                "value": "1.00000000",
                "dataFormatStr": ""
            }
        ]
    ]
}

Code examples

def (isError, data, errorMsg) = Fx.BI.queryLwtViewDataByPage("BI_lwt_1657506871248", 1, 1)
if (!isError) {
    log.info("Pagination info:" + data["page"])
    log.info("Header info:" + data["displayFields"])
    log.info("Dataset:" + data["dataSet"])
} else {
    log.info("Query failed:" + errorMsg)
}

Owner：翟付杰Jeffrey

15. queryLwtViewDataByFilter Query data by filter

Filtering Query Data

Fx.BI.queryLwtViewDataByFilter(<String viewId>, <Array filterList>)

Request parameters

Request Body

Parameter Name	Type	Description	Required
viewId	String	View ID used to specify the target view for querying	Y
filterList	Array[array]	List of filter conditions	Y

filterList	Type	Description	Required
filterId	String	Filter ID	Y
value1	String	Filter value 1	--
value2	String	Filter value 2, used for range queries	--
dateRangeId	Integer	Date range ID	--

Return Parameters

Parameter Name	object	Description
page	Type
displayFields	Type[array]
dataSet	array[array]

page	Type	Description
pageCount	Integer	Total number of pages
pageNumber	Integer	Current page number being displayed
pageSize	Integer	Number of records displayed per page
totalCount	Integer	Total number of records in the dataset

displayFields	object	Description
fieldName	String	Column header name
objName	String	Object name
dbFieldName	String	Field API name
fieldType	String	Field type
columnKey	String	Unique identifier
fieldId	String	Field ID
refObjName	String	Related object API name

dataSet	Type	Description
displayValue	String	Data value for display purposes
value	String	Actual data value
dataFormatStr	String	Data format string
valueCode	String	Data value code

Return an example

{
    "page": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 20,
        "totalCount": 11
    },
    "displayFields": [
        [
            {
                "fieldName": "Primary Attribute",
                "objName": "Guagua",
                "dbFieldName": "name",
                "fieldType": "String",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.bJO7v.Label",
                "fieldId": "BI_61946d085af9d7000104f81c"
            },
            {
                "fieldName": "Creation Time",
                "objName": "Guagua",
                "dbFieldName": "create_time",
                "fieldType": "Date",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.FyMmk.Label",
                "fieldId": "BI_61946d085af9d7000104f82b"
            },
            {
                "refObjName": "org_employee_user",
                "fieldName": "Creator",
                "objName": "Guagua",
                "dbFieldName": "created_by",
                "fieldType": "Circle",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.5KE7p.Label",
                "fieldId": "BI_61946d085af9d7000104f84a"
            },
            {
                "fieldName": "Number (Sum)",
                "objName": "Guagua",
                "dbFieldName": "field_LKyOt__c",
                "fieldType": "Number",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.K4TdN.Label",
                "fieldId": "BI_bb08fc7d10b7035b8dce074e4eedf"
            },
            {
                "fieldName": "Primary Attribute (Unique Count)",
                "objName": "Guagua",
                "dbFieldName": "name",
                "fieldType": "Number",
                "columnKey": "Bi.Custom.Realtime.LwtHeader.BI_lwt_1746698877573.FRgFG.Label",
                "fieldId": "BI_61946d085af9d7000104f81a"
            }
        ]
    ],
    "dataSet": [
        [
            {
                "displayValue": "20250324-1",
                "value": "20250324-1$$67e0d9e27258120007546170",
                "dataFormatStr": ""
            },
            {
                "displayValue": "20250324",
                "value": "20250324",
                "dataFormatStr": ""
            },
            {
                "displayValue": "CN-gua",
                "value": "1198",
                "dataFormatStr": ""
            },
            {
                "displayValue": "193M",
                "value": "192500000.00000000",
                "dataFormatStr": ""
            },
            {
                "displayValue": "1",
                "valueCode": "1044g",
                "value": "1.00000000",
                "dataFormatStr": ""
            }
        ],
        [
            {
                "displayValue": "20250324-2",
                "value": "20250324-2$$67e0fbde7258120007557c6e",
                "dataFormatStr": ""
            },
            {
                "displayValue": "20250324",
                "value": "20250324",
                "dataFormatStr": ""
            },
            {
                "displayValue": "CN-gua",
                "value": "1198",
                "dataFormatStr": ""
            },
            {
                "displayValue": "193M",
                "value": "192500000.00000000",
                "dataFormatStr": ""
            },
            {
                "displayValue": "1",
                "valueCode": "1044g",
                "value": "1.00000000",
                "dataFormatStr": ""
            }
        ]
    ]
}

Code examples

List filterList = [["filterId": "BI_62cb8af6741ac20001debf72", "value1": "", "value2": "", "dateRangeId": 6]];
def (isError, data, errorMsg) = Fx.BI.queryLwtViewDataByFilter("BI_lwt_1657506871248", filterList)
if (!isError) {
    log.info("Pagination info:" + data["page"])
    log.info("Header info:" + data["displayFields"])
    log.info("Dataset:" + data["dataSet"])
} else {
    log.info("Query failed:" + errorMsg)
}

Owner：翟付杰Jeffrey

16. queryMultiDimViewDataById Query Multi-dimensional/Hierarchical Statistical Chart by ID

Query Multi-dimensional/Hierarchical Statistical Chart by ID

Fx.BI.queryMultiDimViewDataById(<String viewId>)

Request parameters

Request Body

Parameter Name	Query by ID	Description	Required
viewId	String	View ID used to specify the view to be queried	Y

Return Parameters

Parameter Name	BI View Display Data	Description
displayFields	Display Field List[object]	Defines the field information displayed in the view
dataSet	Data Set[array]	Query result dataset

displayFields	object	Description
fieldName	String	Field display name
viewFieldId	String	View field ID
fieldId	String	Field ID

dataSet	Data Item	Description
formattedValue	String	Formatted value
formattedShowValue	String	Formatted display value
valueCode	String	Value code, may contain reference ID
value	String	Original value

Return an example

{
    "displayFields": [
        {
            "fieldName": "Customer Name",
            "viewFieldId": "BI_682ae4f89a6d0e000111052f",
            "fieldId": "BI_5bcebcddcab2980001ee22ab"
        },
        {
            "fieldName": "Order Amount",
            "viewFieldId": "BI_682ae4f99a6d0e0001110530",
            "fieldId": "BI_5bceda90dedd2c0001c2f54e"
        }
    ],
    "dataSet": [
        [
            {
                "formattedValue": "Multi-Dimensional Fruits 1",
                "formattedShowValue": "Multi-Dimensional Fruits 1",
                "valueCode": "Multi-Dimensional Fruits 1$$60f14d96fd6db100011adaeb",
                "value": "Multi-Dimensional Fruits 1"
            },
            {
                "formattedValue": "15.3K",
                "formattedShowValue": "15,300.00",
                "valueCode": "15300.0",
                "value": "15300.0"
            }
        ],
        [
            {
                "formattedValue": "Multi-Dimensional Fruits 10",
                "formattedShowValue": "Multi-Dimensional Fruits 10",
                "valueCode": "Multi-Dimensional Fruits 10$$60f14d96fd6db100011adaf9",
                "value": "Multi-Dimensional Fruits 10"
            },
            {
                "formattedValue": "15.39K",
                "formattedShowValue": "15,390.00",
                "valueCode": "15390.0",
                "value": "15390.0"
            }
        ]
    ]
}

Code examples

String viewId = "BI_64e9dc157386e90001dfba59"; //Chart name -> Specified hierarchy with sequence number-3
def (Boolean isError, Nap data, String errorMsg) = Fx.BI.queryMultiDimViewDataById(viewId)
if (!isError) {
    log.info("Header information:" + data["displayFields"])
    log.info("Dataset:" + data["dataSet"])
} else {
    log.info("Query failed:" + errorMsg)
}

Owner：翟付杰Jeffrey

17. queryMultiDimViewDataByFilter Query multi-dimensional/hierarchical statistical charts by filter and chart ID

Query multi-dimensional/hierarchical statistical charts based on filters and chart ID

Fx.BI.queryMultiDimViewDataByFilter(<String viewId>, <Array filters>)

Request parameters

Request Body

Parameter Name	BI Multidimensional View Data Query	Query BI multidimensional view data based on filter conditions	Required
viewId	String	Chart ID, e.g.: BI_64e9dc157386e90001dfba59	Y
filters	Array[array]	List of filter conditions	Y

filters	object	Description	Required
filterId	String	Filter ID	Y
value1	String	Filter value, which can be a JSON string representing complex filter conditions	--
value2	String	Filter value 2, used for range queries	--
dateRangeId	Integer	Date range ID	--

Return Parameters

Parameter Name	BI View Display Data	Description
displayFields	Display Field List[object]	Defines the field information displayed in the view
dataSet	Dataset[array]	Query result dataset

displayFields	object	Description
fieldName	String	Field display name
viewFieldId	String	View field ID
fieldId	String	Field ID

dataSet	Data Item	Description
formattedValue	String	Formatted value
formattedShowValue	String	Formatted display value
valueCode	String	Value code, may contain reference ID
value	String	Original value

Return an example

{
    "displayFields": [
        {
            "fieldName": "Customer Name",
            "viewFieldId": "BI_682ae4f89a6d0e000111052f",
            "fieldId": "BI_5bcebcddcab2980001ee22ab"
        },
        {
            "fieldName": "Order Amount",
            "viewFieldId": "BI_682ae4f99a6d0e0001110530",
            "fieldId": "BI_5bceda90dedd2c0001c2f54e"
        }
    ],
    "dataSet": [
        [
            {
                "formattedValue": "Multi-dimensional Fruit 1",
                "formattedShowValue": "Multi-dimensional Fruit 1",
                "valueCode": "Multi-dimensional Fruit 1$$60f14d96fd6db100011adaeb",
                "value": "Multi-dimensional Fruit 1"
            },
            {
                "formattedValue": "15.3K",
                "formattedShowValue": "15,300.00",
                "valueCode": "15300.0",
                "value": "15300.0"
            }
        ],
        [
            {
                "formattedValue": "Multi-dimensional Fruit 10",
                "formattedShowValue": "Multi-dimensional Fruit 10",
                "valueCode": "Multi-dimensional Fruit 10$$60f14d96fd6db100011adaf9",
                "value": "Multi-dimensional Fruit 10"
            },
            {
                "formattedValue": "15.39K",
                "formattedShowValue": "15,390.00",
                "valueCode": "15390.0",
                "value": "15390.0"
            }
        ]
    ]
}

Code examples

String viewId = "BI_64e9dc157386e90001dfba59"; //Chart ID  Chart Name: Specified Hierarchy with Sequence-3
List filters = [ //Filter Scope
    [
        "filterId":"BI_64e9dc157386e90001dfba60",
        "value1":"[{\"nodeName\":\"Primary Department of Responsible Person-2\",\"optionCode\":2,\"value\":2,\"type\":\"l\"}]"
    ]
]
def (Boolean isError3, Map data3, String errorMsg3) = Fx.BI.queryMultiDimViewDataByFilter(viewId, filters)
if(!isError3) {
  log.info("Header Information:" + data3["displayFields"])
  log.info("Dataset:" + data3["dataSet"])
} else {
  log.info("Conditional Query Failed:" + errorMsg3)
}

Owner：翟付杰Jeffrey