描述

查询报表数据。

请求

名称 是否必需 类型 描述
idOrName String 报表模板Id或者报表模板名称
version Integer 版本号,默认值是-1

响应

  • 返回参数

返回报表数据,列表数据项参数说明:

名称 类型 描述
Id String 模板Id。
Name String 模板名称。
ReportType Integer 模板状态:
- 1简易报表(不跨表)
- 2组合报表(跨表)
- 3汇总报表
- 4固定样式报表
- 5轨迹地图报表
TotalSummary String 234
GroupSummary Integer 创建者名称。
DefaultGroupField String 表内默认分组列。
ForceFit Boolean 是否自动调整宽。
MainDataSource String 数据源。
Creator String 创建人。
CreateTime Boolean 创建时间。
TableMap String 临时表名。
SortType String 报表排序类型 。
- bydata 按指定的报表数据列排序
- bydistance 按距离排序(仅适用于移动端)
SortField String 默认排序列,内容为列的FieldMap。
SortDirection String 排序方向。
- ASC 升序
- DESC 降序
DistanceSortConfig String 报表排序类型为“bydistance”(按距离排序)时,与之相关的设置项 (jsonString)。to do
QueryColumnCount Integer 在常规查询面板中,查询控件的布局列数。
DefaultRange String 默认范围。
Aggregator String 公式类型(已废弃)。
- count 计数
- sum 求和
- avg 平均值
- max 最大值
- min 最小值
- groupSumPercentage 本列求和占比
- groupCountPercentage 本列计数占比
- customize 自定义公式
MeasureField String 仅用于交叉汇总报表 定义了交叉汇总报表的汇总列。
AggregationTitle String 交叉汇总报表的标题。
Status Integer 状态。
- 0 未提交
- 1 已提交
PageSize String 每页记录数。
IsReport Boolean 仅查询。to do
ShowDraftData Boolean 显示未生效数据(草稿数据)。
IsTabGrouping Boolean 是否以页签方式分组。
TabGroupingField String 按页签分组的页签分类列,仅当 IsTabGrouping = true 有效。
QueryMode String 旧版报表模板中标识的报表查询模式。
ClickQureyReportTplId String 旧版报表模板中QueryMode属性标识为'grid'(列表式查询)时,作为查询器的报表模板Id。
ClickQueryReportColumns String 旧版报表模板中QueryMode属性标识为'grid'(列表式查询)时,作为查询器的报表中需要作为查询条件的列Id。
ClickQueryFields String 用于旧版报表的查询器对应查询条件,具体定义规则为:
当QueryMode='normal'(常规查询)时:
ClickQueryFields属性中的多个查询条件列Id的顺序,定义了对应查询下拉框的级联关系
当QueryMode='tree'(树结构查询)时:
ClickQueryFields属性中的多个查询条件列的Id定义了查询树各节点的数据来源(哪个表单的哪个字段),它的顺序定义了树节点的父子关系
当QueryMode='grid'(列表式查询)时:
ClickQueryFields属性中的多个查询条件列Id: 按顺序与ClickQureyReportTplId定义的另外一个报表
(查询器)中由ClickQueryReportColumns属性指定的列一一对应。这样点击该报表的一行时,就可以采集该行中的指定列的值,作为本报表的查询条件进行查询了
QueryModes String 查询模式。
- normal 常规
- tree 树状
- grid 列表
- fuzzy 模糊搜索
QueryNormalName String 本报表常规查询面板的名称。仅当 QueryModes 包含 normal 时有效。
QueryTreeName Boolean 本报表树结构查询面板的名称。仅当 QueryModes 包含 tree 时有效。
QueryCascadeFields String 定义了报表的查询条件间的级联关系,类似于旧版报表模板的ClickQueryFields属性。
QueryFuzzySearchColumns String 定义了模糊查询模式下,需要进行模糊搜索的列。内容是以 ':' 号分隔的多个列的 FieldMap。
QueryFuzzySearchEmptyText String 模糊搜索框为空时的提示文字。
QueryGridsConfig String 新版报表的查询器支持设置多个列表式查询面板,即允许使用其它多个报表作为本报表的查询器。
CreatorName String 创建者姓名。
BatchProcessorConfiguration Object[] 批量处理器的详细设置。待解析
RemoveDuplicate Boolean 排除重复数据。
MapConfig Object 地图类报表配置。
LayoutGraphConfig Object 平面图类报表配置项。待解析
Columns Object[] 报表列。
QueryColumns Object[] 查询列。
KeyFields Boolean 创建时间。
RelatedDataSource Boolean 数据源对象。
RelatedDataObject Array 数据源对象数组。
LeftAxis Array 交叉汇总报表左侧表头的定义。
TopAxis Array 交叉汇总报表左侧表头的定义。
GraphConfigurations Array 图表定义设置。
InternationalName String 国际名称。
  • QueryGridsConfig 参数说明
名称 类型 描述
QueryReportTplId String 查询器报表的模板Id。
QueryFieldsMap Object[] 查询器报表列与本报表查询条件的映射关系。
ShowQueryReportData Boolean 在树状查询器面板不显示列表数据(有可能仅是为了使用该树状查询器)。
VisibleGridColumns String 查询器报表的可见列。
  • QueryFieldsMap 参数说明
名称 类型 描述
QueryGridFieldMap String 查询器报表列。
ReportQueryColumnId String 当前报表查询条件。
  • MapConfig 参数说明
名称 类型 描述
MapServiceProvider String 地图服务平台(默认为百度)。
OriginalAxis String 原始采集的数据坐标体系。
- WGS84 国际GPS坐标
- GCJ02 国测局加密坐标
- BD09 百度二次加密坐标
ObjectIdColumn String 标识唯一设备号的报表列。
LongitudeColumn String 标识定位经度的报表列。
LatitudeColumn String 标识定位纬度的报表列。
GSMDistColumn String 标识基站区号的报表列。
GSMTowerColumn String 标识基站塔号的报表列。
LabelFirstColumn String 标识位置点点击后显示标签中第一项突出显示内容的报表列。
DataLabelColumns String 标识位置点点击后显示标签中需要显示的其它报表列。
PointLabelColumn String 标识在每个位置点悬浮显示的提示标签内容的报表列。
GPSTimeStampColumn String 标识GPS定位时间戳的报表列。
GSMTimeStampColumn String 标识基站定位时间戳的报表列。
TerminalStatusColumn String 标识终端设备状态的报表列。
MapStyle String 地图渲染风格。
- light 淡雅
- light 正常
- light 夜间
PointIcon String 位置点标注图标的名称,每个名称对应一个图片的URL。
TrackLineType String 轨迹线条类型。
TrackLineColor String 轨迹线条颜色代码(HTML规范)。
TrackPointColor String 轨迹点颜色(HTML规范)。
MapTools String 要使用的地图工具名称,如果采用多个,以','分隔。
- distanceTool 距离测量工具
- rectangleZoom 矩形放大工具
- lushu 轨迹回放工具
  • Columns 参数说明
名称 类型 描述
Id String 列Id。
ReportTplId String 报表模板Id。
FormId String 表单模板Id。
FieldId String 来源字段Id。
FieldMap String 列名。
ColumnWidth String 列宽。
Header String 表头名称。
DataType Integer 列的数据类型:
- 0 字符串
- 1 数值
- 2 日期时间
Unit String 计量单位。
TimeZone String 时间精度。
IsDate Boolean 是否时间格式。
IsAddress Boolean 是否地址格式。
IsPicture Boolean 是否图片格式。
IsAttachment Boolean 是否附件格式。
OrderIndex Integer 列的显示顺序。
IsFormulation Boolean 是否公式运算。
IsOperator Boolean 是否引用工作流节点执行者的列。
IsOperateTime Boolean 是否引用工作流节点执行时间的列。
Hidden Boolean 是否隐藏。
ColumnStyle Object 列的前端显示样式。待解析
DataFormat Object 列的值相关设置。
DataLink Object 列穿越的相关设置。待解析
InternationalHeader String 国际化列表头文字。
UseVisualPrecise Boolean 属性允许后台在计算自定义公式时,对标识了使用显示精度进行计算的列。
CalculateAfterPaging Boolean CalculateAfterPaging = true 时,后台在完成查询数据的分页后,才进行自定义公式列的计算,即只计算当前页的自定义公式列。。
GetValueFromCache String 获取数据唯一性的 key。
AllowEdit Boolean 是否可以修改。
  • DataFormat 参数说明
名称 类型 描述
DataPrefix String 数据前面显示的附加内容。
DataSuffix String 数据后面显示的附加内容。
ThousandSpliter Boolean 使用千位分隔符。
useVisualPrecision Boolean 使用显示精度参与计算。
DateFormat String 日期时间格式。
NeedConvertGTM Boolean 是否格林威治时间。
  • QueryColumns 参数说明
名称 类型 描述
Id String 表头列。
DataType Integer 数据类型:
- 1 字符型
- 2 数值型
- 3 日期型
DefaultValue String 默认值。
DefaultOperator String 默认关系符。
FieldId String 列Id。
FieldMap String 列名。
ReportTplId String 报表Id。
FormId String 表单Id。
WFNodeId String 节点Id。
WFTplId String 工作流模板Id。
Header String 表头列。
InternationalHeader String 国际化表头列。
IsAddress Boolean 是否地址类型。
IsDate Boolean 是否日期类型。
IsDefaultTimeCondition Boolean 是否为自定义的查询列。
IsLock Boolean 是否锁定。
IsOperateTime Boolean 是否比较时间类型。
IsOperator Boolean 是否运算符。
IsPopular Boolean 是否优先。
IsQueryHidden Boolean 是否隐藏。
NumType Integer 统计值字段的数字类型:
- 1 数值
- 2 货币
- 3 百分比。
OrderIndex Integer 列的顺序。
Summary String 列汇总。
TailDigits Integer 统计值字段的小数位数,最多8位。
TimeZone String 时分秒。
- none 无格式
- fulltime 全部
  • LeftAxis 参数说明
名称 类型 描述
Id String 表头项Id 。
FieldMap String 被选取作为左侧表头的报表列。
Header String 被选取作为左侧表头的报表列的表头文字。
SortDirection String 被选取作为左侧表头的数据排序方向。
OrderIndex String 表头序号。
ReportTplId String 报表模板Id。
  • TopAxis 参数说明
名称 类型 描述
Id String 表头项Id 。
FieldMap String 被选取作为顶部表头的报表列。
Header String 被选取作为顶部表头的报表列的表头文字。
SortDirection String 被选取作为顶部表头的数据排序方向。
OrderIndex String 表头序号。
ReportTplId String 报表模板Id。

示例

请求示例

GET  /v1/report/templates/bddbfff3-3d8d-4539-b7e4-6f67ab1ec6e9?version=-1 HTTP/1.1
Host: api.dadayun.cn
Date: Thu, 30 Aug 2018 02:55:22 GMT

正常返回示例

HTTP/1.1 200 OK
Date: Thu, 30 Aug 2018 02:55:22 GMT
Content-Type: application/json; charset=utf-8

{
    "Id": "bddbfff3-3d8d-4539-b7e4-6f67ab1ec6e9",
    "Name": "产品信息查询",
    "ReportType": 2,
    "TotalSummary": false,
    "GroupSummary": false,
    "DefaultGroupField": "",
    "ForceFit": true,
    "MainDataSource": "af1c1f86-7336-4c8b-942d-7fff47f3d161",
    "Creator": "d63f3678-5082-4c8a-9bd5-5aef58c2be08",
    "CreateTime": "2015-05-28T13:55:30Z",
    "TableMap": "t1",
    "SortType": null,
    "SortField": "",
    "SortDirection": "ASC",
    "DistanceSortConfig": null,
    "QueryColumnCount": 2,
    "DefaultRange": "全部",
    "Aggregator": "sum",
    "MeasureField": "[]",
    "AggregationTitle": "",
    "Status": 1,
    "PageSize": 200,
    "IsReport": true,
    "ShowDraftData": false,
    "IsTabGrouping": false,
    "TabGroupingField": null,
    "QueryMode": "tree",
    "ClickQureyReportTplId": "",
    "ClickQueryReportColumns": null,
    "ClickQueryFields": "36fe4b23-90b8-41c8-8a5a-52444491d678,227e5afc-922f-4682-a112-0f5117535333,da830e78-*d353-4554-8d2b-6ced7e73b975,e9111279-8138-43f6-a6b7-a4c91133ca8c",
    "QueryModes": "normal,tree",
    "QueryNormalName": "产品普通查询器",
    "QueryTreeName": "产品查询树",
    "QueryCascadeFields": "36fe4b23-90b8-41c8-8a5a-52444491d678,227e5afc-922f-4682-a112-0f5117535333,da830e78-*d353-4554-8d2b-6ced7e73b975,e9111279-8138-43f6-a6b7-a4c91133ca8c",
    "QueryFuzzySearchColumns": null,
    "QueryFuzzySearchEmptyText": null,
    "QueryGridsConfig": null,
    "CreatorName": null,
    "BatchProcessorConfiguration": "{\"batchModeEnable\":true,\"batchMode\":1,\"listInputCfg\":{\"actionType\":2,\"btnActionText\":*\"发起采购申请\",\"tempFolderText\":\"购物车\",\"wfTplId\":\"8ac78f4c-a7eb-4d0c-ab8e-19930fa4ec6f\",\"wfTplName\":\"采购申请\",*\"formTplId\":\"240ed22e-b775-4c80-9050-f73b8843f7a4\",\"formTplName\":\"采购申请单\",\"subEntityFormId\":*\"930a4ebc-2a8e-4502-8b20-abd7cfb3aa91\",\"maps\":[{\"ReportColumn\":\"名称\",\"FormField\":\"采购货品清单-名称\"},{\"ReportColumn*\":\"品牌\",\"FormField\":\"采购货品清单-品牌\"},{\"ReportColumn\":\"系列\",\"FormField\":\"采购货品清单-系列\"},{\"ReportColumn\":*\"型号\",\"FormField\":\"采购货品清单-型号\"},{\"ReportColumn\":\"产品类别\",\"FormField\":\"采购货品清单-类别\"},{\"RecId\":\"ext-*gen1069\",\"ReportColumn\":\"测试\",\"FormField\":\"采购货品清单-金额\"}]},\"batchFormEditorCfg\":{},\"batchTaskCfg\":{}}",
    "RemoveDuplicate": false,
    "MapConfig": null,
    "LayoutGraphConfig": null,
    "Columns": [
        {
            "Id": "c692881f-1f83-4291-80b2-0102db759791",
            "ReportTplId": "bddbfff3-3d8d-4539-b7e4-6f67ab1ec6e9",
            "FormId": "af1c1f86-7336-4c8b-942d-7fff47f3d161",
            "FieldId": "684923ae-6fac-4e63-b67a-1791771c5536",
            "FieldMap": "F0",
            "TableMap": "t1",
            "ColumnWidth": 100,
            "Summary": null,
            "Level": null,
            "Header": "产品类别",
            "DataType": 0,
            "NumType": null,
            "TailDigits": null,
            "Unit": null,
            "TimeZone": "0",
            "IsDate": false,
            "IsAddress": false,
            "IsPicture": false,
            "IsAttachment": false,
            "OrderIndex": 0,
            "IsFormulation": false,
            "Formulation": null,
            "IsOperator": false,
            "IsOperateTime": false,
            "WFTplId": null,
            "WFNodeId": null,
            "Hidden": false,
            "Color": null,
            "ColumnStyle": null,
            "DataFormat": null,
            "DataLink": null,
            "InternationalHeader": "产品类别",
            "UseVisualPrecise": false,
            "CalculateAfterPaging": false,
            "GetValueFromCache": false,
            "CacheKeyPreString": null,
            "CacheKeyColumns": null
        },
        ...
    ],
    "QueryColumns": [
        {
            "Id": "36fe4b23-90b8-41c8-8a5a-52444491d678",
            "ReportTplId": "bddbfff3-3d8d-4539-b7e4-6f67ab1ec6e9",
            "OperatorList": null,
            "DefaultOperator": "包含",
            "IsPopular": true,
            "OrderIndex": 0,
            "ShowOperator": true,
            "FieldMap": "t1.Field4",
            "DatetimeQueryField": null,
            "DataType": 0,
            "NumType": null,
            "TailDigits": null,
            "Unit": null,
            "Header": "名称",
            "Summary": null,
            "TimeZone": null,
            "IsDate": false,
            "IsAddress": false,
            "Level": null,
            "FieldId": "a8c156af-6d8a-41f7-a7b8-36094e738a02",
            "FormId": "af1c1f86-7336-4c8b-942d-7fff47f3d161",
            "WFTplId": null,
            "WFNodeId": null,
            "IsDefaultTimeCondition": false,
            "IsOperator": null,
            "IsOperateTime": null,
            "DefaultValue": "",
            "IsLock": false,
            "InternationalHeader": "名称",
            "IsQueryHidden": null
        },
        ...
    ],
    "KeyFields": [],
    "RelatedDataSource": [],
    "RelatedDataObject": [
        {}
    ],
    "LeftAxis": [],
    "TopAxis": [],
    "GraphConfigurations": [],
    "InternationalName": "产品信息查询"
}

异常返回示例

HTTP/1.1 500 Internal Server Error
Date: Thu, 30 Aug 2018 02:55:22 GMT
Content-Type: application/json; charset=utf-8

{
  "Code": "Invalid_Param",
  "Message": "验证参数fields不合法"
}

错误码

错误代码(Code) 错误信息(Message) HTTP 状态码(StatusCode) 说明
Invalid_ReportTplId_NotFound 名称等于“XXX”的报表模板不存在。 400 报表模板不存在。
InternalError 未知错误。 500 服务器内部错误,请联系管理员。

results matching ""

    No results matching ""