描述

获取报表模板列表。

请求

名称 是否必需 类型 描述
fields 否 String 返回字段，多个字段用半角逗号分割（例如：Id,Name）,
fields允许包含的字段（Id, Name, Status, ReportType, CreatorName, CreateTime）。
filter 否 String 筛选条件json字符串，参考下文 filter 模板。
start 否 Integer 分页开始索引，默认值0
limit 否 Integer 每页数据,默认值是20
sort 否 String 排序字段(只支持单个字段)。
降序前面加-（例如：-CreateTime 表示单据模板列表按创建时间降序）。
count 否 bool 返回总数，总数字段在Response的Header里，名为Total-Count。
  • filter 参数说明：
名称 是否必需 类型 描述1
Id 是 String 查询字段Id。
Operator 是 String 运算参数:
- = 等于
- <> 不等于
- like 包含
- not like 不包含
- > 大于
- > 大于
- >= 大于等于
- < 小于
- range 范围
Value1 是 String 比较值(使用范围条件时的较小值)。
Value2 否 String 使用范围条件时的较大值。

响应

  • 返回参数

返回报表模板列表，列表数据项参数说明：

名称 类型 描述
Id String 模板Id。
Name String 模板名称。
Status String 模板状态:
- 0 未提交
- 1 已提交
ReportType String 报表模板类型，
- 1 简易报表(使用单一单据数据)
- 2 组合报表(使用多个关联单据数据)
- 3 汇总报表(复杂表头,使用多个关联单据数据)
- 4 地图（多目标位置点）
- 5 地图（单目标轨迹）
- 6 平面图（多目标位置点）
CreatorName Integer 创建者名称。
CreateTime Boolean 创建时间。

示例

请求示例 

HTTP/1.1
GET  /v1/report/templates?fields=Name,Status&filter=xxx&st art=0&limit=20&sort=-CreateTime&count=false
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": "ec2019ab-041c-4ebf-a34e-adb9097a9fa0",
      "Name": "拜访报告",
      "Status": 1,
      "ReportType": 1,
      "CreatorName": "系统管理员",
      "CreateTime": "2015-05-28T05:55:30Z"
  },
  {
      "Id": "95149dfb-a63e-458f-927d-70fcee61abd1",
      "Name": "报销统计表",
      "Status": 1,
      "ReportType": 1,
      "CreatorName": "系统管理员",
      "CreateTime": "2015-05-28T05:55:30Z"
  },
  ...
]

异常返回示例 

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 名称等于“XXX”的报表模板不存在。 400 报表模板不存在。
InternalError 未知错误。 500 服务器内部错误，请联系管理员。

results matching ""

    No results matching ""