描述

查询报表数据。

请求

名称 是否必需 类型 描述
fields String 返回字段,多个字段用半角逗号分割(例如:Id,Name),
fields允许包含的字段(Id, Name, Status, ReportType, CreatorName, CreateTime)等。
filter String 筛选条件json字符串,参考公共参数 filter
start Integer 分页开始索引,默认值0
limit Integer 每页数据,默认值20
groupBy String 分组字段,只允许一个字段,降序前面加-。
sort String 排序字段,降序前面加-(例如:-CreateTime 表示单据模板列表按创建时间降序)。
sampleStep Integer 对于地图服务请求的超量数据,按照设定的采 样率,每隔sampleStep条采用一条。
sortByDistanceJson String 请求对报表数据按距离排序,limit将设置为3000。
keyOption String 返回的字段以属性为键值,
- 0 FieldMap,
- 1 Id
- 2 报表列名。
aggResult Boolean 返回聚合结果,报表类型为简易报表或组合报表可用。
count Boolean 返回总数,总数字段在Response的Header里,名为Total-Count。

响应

  • 返回参数

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

名称 类型 描述
Results Object[] 报表查询结果集。
Results.FX Object 报表动态列。
Results.dataObjsatus Object[] 报表当前行数据来源对象,报表数据来源于单据、流程。参考下文 dataObjsatus 参数说明
AggregationResult Object[] 报表聚合列结果字典,简易报表和组合报表才有。
AggregationResult.Key String 聚合列列名。
AggregationResult.Value Object 聚合列聚合值。
  • dataObjsatus 参数说明:
名称 类型 描述
formInstances Object[] 报表当前行数据来源为单据对象,一行可以来源多个单据实例数据。参考下文 formInstances 参数说明
subFormInstances Object[] 单据子表(列表控件)信息。参考下文 subFormInstances 参数说明
wfInstances Object[] 报表当前行数据来源为流程对象,一行可以来源多个流程实例数据。参考下文 wfInstances 参数说明
  • formInstances 参数说明:
名称 类型 描述
tplId String 单据模板Id。
tplName String 单据模板名称。
tplType Number 单据模板类型:
- 0 普通动态单据
- 1 员工信息表
- 2 客户信息表
- 3 供应商信息表
- 4 产品信息表
- 5 财务凭证
- 6 新闻公告或收发文表单
instanceId String 单据实例Id。
title String 单据实例标题。
isValid Number 单据实例是否已提交,
- 0 草稿,
- 1 已提交。
isBlock Number 单据实例是否工作流携带,
- 0 否,
- 1 是。
subFormInstances Object[] 单据子表(列表控件)信息。
  • subFormInstances 参数说明:
名称 类型 描述
tplId String 单据子表(列表控件)信息。
tplName String 单据子表(列表控件)信息。
instanceId String 单据子表(列表控件)当前行实例Id。
  • wfInstances 参数说明:
名称 类型 描述
tplId String 流程模板Id。
tplName String 流程据模板名称。
instanceId String 流程实例Id。
title String 流程实例标题。
status String 流程实例当前状态。
tplName String 流程据模板名称。

示例

请求示例

HTTP/1.1
GET  /v1/report/templates/2c63a2c4-b1ef-4dd0-bf0d-0434cdf15c6f/search?fields=F0,F1,F2,F3,F4&filter=[{"Name":"月度","Operator":"like","DestValue":"07"}]&start=0&limit=20&groupBy=-CreateTime&sort=&aggResult=true&keyOption=0&count=true
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

{
    "Results": [
        {
            "ROWNUM": "1",
            "F0": "B公司",
            "F1": "赵柳",
            "F2": "15912345678",
            "F3": "2018-05-01",
            "F4": "",
            "dataObjs": {
                "formInstances": [
                    {
                        "tplId": "cbdbb6f4-96ff-47d8-91c4-7700f4a2b0fc",
                        "tplName": "客户信息表",
                        "tplType": 0,
                        "instanceId": "54b9b492-e616-4f21-92a0-c50b23fa3e0d",
                        "title": "新建客户信息表_2018-05-16_86822",
                        "isValid": 1,
                        "isBlock": 0,
                        "subFormInstances": [
                            {
                                "tplId": "87cf07b1-ef22-4718-a97d-e7ff69e0a264",
                                "tplName": "客户信息表子表",
                                "instanceId": "99815e70-e937-4237-8f3d-4d2560ecc9d8"
                            }
                        ]
                    }
                ],
                "wfInstances": []
            }
        },
]

}


**异常返回示例** 

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

{
  "Code": "InternalError",
  "Message": "未知错误"
}

错误码

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

results matching ""

    No results matching ""