描述

获取单据实例，返回数据只包含单据实例字段值，url查询参数必须带上containsAuthority=false。
如果开发者开发的是Web页面，或者需要单据权限，请参考获取单据实例（包含权限），与获取单据实例（包含权限）接口的差异在于此场景主要用于开发者不关心单据权限部分（实际返回的数据已经处理过权限，比如没权限查看的字段是不返回或返回空值），简化了返回数据结构，开发者在调用API成功后通过返回的数据使用序列化库直接反序列化成自己定义的对象（使用Entity为键，字段的实体属性名称与自己定义的对象属性相同即可）或字典。

请求

URL

https://api.dadayun.cn/v1/form/templates/$idOrName/instances/$instanceId?containsAuthority=false&keyOption=$keyOption
HTTP请求方式

GET
HTTP请求参数

名称	是否必需	类型	描述
idOrName	是	String	单据模板 Id/名称/实体名称。
instanceId	是	String	单据实例Id。
keyOption	否	String	提交的实例数据和返回的实例数据以什么为属性名（键名）。属性名： - `Entity` 以实体属性名为属性名； - `Caption` 以[组名-]控件名为属性名； - `Id` 以字段的Id为属性名； - `FieldName` 以字段的FieldName为属性名，默认。
fields	否	String	返回字段；多个字段用英文半角逗号分割（例如：Id,Name；字段值与 `keyOption`有关）。默认值为空，返回所有字段。

响应

返回单据实例对象，单据实例对象是包含若干属性值对（key-value，也称「键值对」），返回参数：

名称	类型	描述
Id	String	实例Id。
IsValid	Boolean	是否已提交： - `false` 未提交（草稿）； - `true` 已提交。
IsBlock	Boolean	是否流程携带的实例。
DataEnable	Boolean	是否已生效。
CreatorName	String	创建时，创建者名称。
ModifyByName	String	修改者名称。
CreatorPosition	String	创建时，创建者部门岗位名称。
$Field	Object	字段 Id/名称/实体名称（由请求的`keyOption`决定）。

以上Id、IsValid、IsBlock、DataEnable、CreatorName、ModifyByName、CreatorPosition是固定字段，每个单据实例都有；
$Field表示动态字段，字段的数量由所设计的单据模板决定，数据结构参照下文返回示例。

示例

以员工信息表为例，以下返回示例为了便于用户查看，省略了部分属性或值：

1. 以Entity作为键名（key）（推荐）：

请求示例

GET  /v1/form/templates/Employee/instances/a1e38673-ae69-4536-acac-a27dc46da856?keyOption=Entity&containsAuthority=false  HTTP/1.1
Host: api.dadayun.cn
Date: Wed, 05 Sep 2018 09:30:18 GMT

正常返回示例

HTTP/1.1 200 OK
Date: Wed, 05 Sep 2018 09:30:18 GMT
Content-Type: application/json; charset=utf-8

{
    "Id": "a1e38673-ae69-4536-acac-a27dc46da856",
    "IsBlock": false,
    "IsValid": true,
    "DataEnable": true,
    "CreatorName": "系统管理员",
    "ModifyByName": "系统管理员",
    "CreatorPosition": "系统管理员",
    "Title": "在职_系统管理员",
    "Status": "在职",
    "EmployeeNumber": "NO.1",
    "Name": "系统管理员",
    "Portrai": [
        {
            "Id": "form/.../myPortrai.jpg",
            "FileName": "myPortrai.jpg",
            "FileLength": 148931,
            "Original": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg",
            "Thumbnail": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg@!p50",
            "Bmiddle": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg@!p200"
        }
    ],
    "Gender": "男",
    "Creator": "a1e38673-ae69-4536-acac-a27dc46da856",
    "CreatorPositionId": "00000000-0000-0000-0000-000000000000",
    "CreateTime": "2018-05-25T02:04:24.567Z",
    "ModifyBy": "a1e38673-ae69-4536-acac-a27dc46da856",
    "ModifyTime": "2018-09-06T07:26:56.077Z",
    "Educations": [
        {
            "Id": "c2aa83df-c1c3-40c5-b409-0718ef8edefb",
            "StartDate": "200809",
            "EndDate": "201206",
            "EduServices": "XX大学",
            "Major": "软件技术",
            "Certificate": null,
            "OrderIndex": 0
        }
    ]
}

2. 以Caption作为键名（key）：

请求示例

GET /v1/form/templates/%E5%91%98%E5%B7%A5%E4%BF%A1%E6%81%AF%E8%A1%A8/instances/a1e38673-ae69-4536-acac-a27dc46da856?keyOption=Caption&containsAuthority=false  HTTP/1.1
Host: api.dadayun.cn
Date: Wed, 05 Sep 2018 09:30:18 GMT

正常返回示例

HTTP/1.1 200 OK
Date: Wed, 05 Sep 2018 09:30:18 GMT
Content-Type: application/json; charset=utf-8

{
    "Id": "a1e38673-ae69-4536-acac-a27dc46da856",
    "IsBlock": false,
    "IsValid": true,
    "DataEnable": true,
    "CreatorName": "系统管理员",
    "ModifyByName": "系统管理员",
    "CreatorPosition": "系统管理员",
    "标题": "在职_系统管理员",
    "在职状态": "在职",
    "基本信息-员工编号": "NO.1",
    "基本信息-姓名": "系统管理员",
    "基本信息-照片": [
        {
            "Id": "form/.../myPortrai.jpg",
            "FileName": "myPortrai.jpg",
            "FileLength": 148931,
            "Original": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg",
            "Thumbnail": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg@!p50",
            "Bmiddle": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg@!p200"
        }
    ],
    "基本信息-性别": "男",
    "创建人": "a1e38673-ae69-4536-acac-a27dc46da856",
    "创建人岗位": "00000000-0000-0000-0000-000000000000",
    "创建时间": "2018-05-25T02:04:24.567Z",
    "修改人": "a1e38673-ae69-4536-acac-a27dc46da856",
    "修改时间": "2018-09-06T07:26:56.077Z",
    "教育背景-教育背景": [
        {
            "Id": "c2aa83df-c1c3-40c5-b409-0718ef8edefb",
            "教育背景-自(年月)": "200809",
            "教育背景-至(年月)": "201206",
            "教育背景-教育机构": "XX大学",
            "教育背景-专业": "软件技术",
            "教育背景-证书名称及编号": null,
            "OrderIndex": 0
        }
    ]
}

3. 以Id作为键名（key）：

请求示例

GET  /v1/form/templates/4bc85381-2209-4f36-a073-b1a7795bcd00/instances/a1e38673-ae69-4536-acac-a27dc46da856?keyOption=FieldName&containsAuthority=false  HTTP/1.1
Host: api.dadayun.cn
Date: Wed, 05 Sep 2018 09:30:18 GMT

正常返回示例

HTTP/1.1 200 OK
Date: Wed, 05 Sep 2018 09:30:18 GMT
Content-Type: application/json; charset=utf-8

{
    "Id": "a1e38673-ae69-4536-acac-a27dc46da856",
    "IsBlock": false,
    "IsValid": true,
    "DataEnable": true,
    "CreatorName": "系统管理员",
    "ModifyByName": "系统管理员",
    "CreatorPosition": "系统管理员",
    "a92299dd-f270-4a91-9252-a46de335056e": "在职_系统管理员",
    "dc22db37-5ddb-412d-81db-d71c272a9740": "在职",
    "836a4b6f-133b-4204-ae82-ac26713a2b98": "NO.1",
    "83035ce3-a6de-4296-b3db-a73cb5de3725": "系统管理员",
    "5d54877e-1646-4744-867c-a57b5b9365c2": [
        {
            "Id": "form/.../myPortrai.jpg",
            "FileName": "myPortrai.jpg",
            "FileLength": 148931,
            "Original": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg",
            "Thumbnail": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg@!p50",
            "Bmiddle": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg@!p200"
        }
    ],
    "7a3a45f5-8551-46f6-9bc1-4742929f9921": "男",
    "8500f40c-f940-4fe1-9320-da4e0ff81204": "a1e38673-ae69-4536-acac-a27dc46da856",
    "fc747c65-7460-4f5d-9203-8d79c7ba19fd": "00000000-0000-0000-0000-000000000000",
    "87fb1c30-9299-4380-8d24-5aa78e393ff2": "2018-05-25T02:04:24.567Z",
    "a1364f13-6be7-4378-a0f8-8a464ac1d771": "a1e38673-ae69-4536-acac-a27dc46da856",
    "7a372af9-a78c-4e44-8493-42acfad1bce0": "2018-09-06T07:26:56.077Z",
    "d0d35fcf-23a9-43fd-bc63-71e82f4dfe79": [
        {
            "Id": "c2aa83df-c1c3-40c5-b409-0718ef8edefb",
            "7a7a89a0-b73d-42e5-8df3-1c11a60af05e": "200809",
            "6b8bcb9b-dafb-4720-a5a9-87ac95501434": "201206",
            "ccff267b-0bdf-40bb-9f77-52ff95223190": "XX大学",
            "7358d99b-82f7-44b9-970b-47b60807582f": "软件技术",
            "224f6a06-9c15-4d03-a41b-2f1e425907c4": null,
            "OrderIndex": 0
        }
    ]
}

4. 以FieldName作为键名（key）：

请求示例

GET  /v1/form/templates/4bc85381-2209-4f36-a073-b1a7795bcd00/instances/a1e38673-ae69-4536-acac-a27dc46da856?keyOption=FieldName&containsAuthority=false  HTTP/1.1
Host: api.dadayun.cn
Date: Wed, 05 Sep 2018 09:30:18 GMT

正常返回示例

HTTP/1.1 200 OK
Date: Wed, 05 Sep 2018 09:30:18 GMT
Content-Type: application/json; charset=utf-8

{
    "Id": "a1e38673-ae69-4536-acac-a27dc46da856",
    "IsBlock": false,
    "IsValid": true,
    "DataEnable": true,
    "CreatorName": "系统管理员",
    "ModifyByName": "系统管理员",
    "CreatorPosition": "系统管理员",
    "Title": "在职_系统管理员",
    "status": "在职",
    "employeenumber": "NO.1",
    "name": "系统管理员",
    "Field1": [
        {
            "Id": "form/.../myPortrai.jpg",
            "FileName": "myPortrai.jpg",
            "FileLength": 148931,
            "Original": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg",
            "Thumbnail": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg@!p50",
            "Bmiddle": "https://jz-file.oss-cn-hangzhou.aliyuncs.com/form/.../myPortrai.jpg@!p200"
        }
    ],
    "Field4": "男",
    "Creator": "a1e38673-ae69-4536-acac-a27dc46da856",
    "CreatorPositionId": "00000000-0000-0000-0000-000000000000",
    "CreateTime": "2018-05-25T02:04:24.567Z",
    "ModifyBy": "a1e38673-ae69-4536-acac-a27dc46da856",
    "ModifyTime": "2018-09-06T07:26:56.077Z",
    "28b053ec-ad1a-4fb5-8421-11d4a94a913b": [
        {
            "Id": "c2aa83df-c1c3-40c5-b409-0718ef8edefb",
            "Field31": "200809",
            "Field32": "201206",
            "Field33": "XX大学",
            "Field34": "软件技术",
            "Field35": null,
            "OrderIndex": 0
        }
    ]
}

获取单据实例

描述

请求

响应

示例

1. 以Entity作为键名（key）（推荐）：

2. 以Caption作为键名（key）：

3. 以Id作为键名（key）：

4. 以FieldName作为键名（key）：

results matching ""

No results matching ""