描述
获取单据模板列表。
请求
URL
HTTP请求方式
GET
HTTP请求参数
名称 | 是否必需 | 类型 | 描述 | 参数值 |
---|---|---|---|---|
fields | 否 | String | 返回字段,多个字段用半角逗号分割(例如:Id,Name). | fields允许包含的字段:Id, Name, CreatorName, Status, HasInstance, CreateTime, TplType 。默认值为空,返回所有字段。 |
filter | 否 | String | 筛选条件,目前只支持按单据名称模糊搜索; | |
start | 否 | Integer | 分页开始索引。 | 0-2147483647范围内某个整数值,默认值为0。 |
limit | 否 | Integer | 每页数据。 | 0-2147483647范围内某个整数值,默认值为20。 |
sort | 否 | String | 排序字段(只支持单个字段),降序前面加-(例如:-CreateTime 表示单据模板列表按创建时间降序)。 |
可选字段:Name, Status, CreateTime, TplType 。默认值为-CreateTime 。 |
count | 否 | Boolean | 是否返回总记录数,总记录数字段在Response的Header里,名为Total-Count。 | true/false,默认为false。 |
响应
- 返回参数
名称 | 类型 | 描述 |
---|---|---|
Id | String | 模板Id |
Name | String | 模板名称 |
TplType | Integer | 模板类型: - 0 普通动态单据;- 1 员工信息表;- 2 客户信息表;- 3 供应商信息表;- 4 产品信息表;- 5 财务凭证。 |
Status | Integer | 模板状态: - 0 未提交;- 1 已提交。 |
HasInstance | Boolean | 是否有实例数据。 |
CreatorName | String | 创建者名称。 |
CreateTime | String | 创建时间。 |
示例
请求示例
GET /v1/form/templates?start=0&limit=20&sort=-CreateTime&count=true HTTP/1.1
Host: api.dadayun.cn
Date: Mon, 03 Sep 2018 01:49:35 GMT
正常返回示例
HTTP/1.1 200 OK
Date: Mon, 03 Sep 2018 01:49:35 GMT
Content-Type: application/json; charset=utf-8
Total-Count: 194
[
{
"Id": "da9f5a2a-6811-446d-bedf-c67b5c1bcc1e",
"Name": "销售订单",
"TplType": 1,
"Status": 1,
"HasInstance": true,
"CreatorName": "系统管理员",
"CreateTime": "2015-05-28T05:55:17Z"
},
{
"Id": "1861e1ac-8c56-4b8a-810d-7c6d9df02a92",
"Name": "Alan测试日期控件",
"TplType": 0,
"Status": 1,
"HasInstance": false,
"CreatorName": "业务管理员",
"CreateTime": "2015-09-22T03:02:10Z"
}
]