描述

获取单据实例列表。

请求

名称 是否必需 类型 描述
idOrName 是 String 单据模板 Id/名称/实体名称。
keyOption 否 String 提交的实例数据和返回的实例数据以什么为属性名（键名）。
属性名：
- Entity 以实体属性名为属性名；
- Caption 以[组名-]控件名为属性名；
- Id 以字段的Id为属性名；
- FieldName 以字段的FieldName为属性名，默认。
fields 否 String 返回字段；多个字段用英文半角逗号分割（例如：Id,Name；字段值与 keyOption有关）。默认值为空，返回所有字段。
filter 否 String 筛选条件Json字符串。见下文。
start 否 Integer 分页开始索引。0-2147483647范围内某个整数值，默认值为0。
limit 否 Integer 每页数据。0-2147483647范围内某个整数值，默认值为20。
sort 否 String 排序字段(只支持单个字段，与 keyOption有关)，降序前面加-（例如：-CreateTime 表示单据实例列表按创建时间降序）。
默认值为-CreateTime。
count 否 Boolean 是否返回总记录数，总记录数字段在Response的Header里，名为Total-Count。
true/false，默认为false。
  • filter参数

示例：

filter=[{"id":"拜访单单号","Operator":"=","value1":"Quotation2017062301"}]
名称 是否必需 类型 描述
id 是 String 字段Id或名称，与 keyOption有关。
operator 否 String 操作符：
- like 包含，默认；
- = 等于；
- <> 不等于；
- > 大于；
- >= 大于或等于；
- < 小于；
- <= 小于或等于；
- empty 等于字符串空或null；
- range 大于或等于value1并且小于等于value2。
value1 是 String 条件值1，非范围操作符（Operator != range）的条件值；范围操作符时，最小值。
value2 否 String 条件值2，范围操作符时（Operator = range），最大值。

响应

  • 返回参数
名称 类型 描述
Id String 实例Id。
IsValid Boolean 是否已提交：
- false 未提交（草稿）；
- true 已提交。
IsBlock Boolean 是否流程携带的实例。
DataEnable Boolean 是否已生效。
Title String 实例标题。
Creator String 创建者Id。
CreatorName String 创建时，创建者名称。
CreateTime String 创建时间。
ModifyByName String 修改者名称。
ModifyTime String 修改时间。
FormType Integer 单据模板类型：
- 0 普通动态单据；
- 1 员工信息表；
- 2 客户信息表；
- 3 供应商信息表；
- 4 产品信息表；
- 5 财务凭证。。
Field1 String 其它字段，fields指定的返回字段。

示例

请求示例 

GET  /v1/form/templates/4bc85381-2209-4f36-a073-b1a7795bcd00/instances?keyOption=FieldName&start=0&limit=20&sort=-CreateTime&count=true  HTTP/1.1
Host: api.dadayun.cn
Date: Wed, 05 Sep 2018 09:26:31 GMT

正常返回示例 

HTTP/1.1 200 OK
Date: Wed, 05 Sep 2018 09:26:31 GMT
Content-Type: application/json; charset=utf-8
Total-Count: 1

[
    {
        "Id": "a1e38673-ae69-4536-acac-a27dc46da856",
        "IsBlock": false,
        "IsValid": true,
        "DataEnable": true,
        "Title": "在职_系统管理员",
        "Creator": "a1e38673-ae69-4536-acac-a27dc46da856",
        "CreatorName": "系统管理员",
        "CreateTime": "2018-05-25T02:04:24.567Z",
        "ModifyByName": "系统管理员",
        "ModifyTime": "2018-05-25T02:04:24.567Z",
        "Field1": []
    }
]

results matching ""

    No results matching ""