描述
创建单据实例。
请求
URL
HTTP请求方式
POST
Header参数
{ "Content-Type":"application/json; charset=utf-8" }
HTTP请求参数
URL参数
名称 | 是否必需 | 类型 | 描述 |
---|---|---|---|
idOrName | 是 | String | 单据模板 Id/名称/实体名称。 |
keyOption | 否 | String | 提交的实例数据和返回的实例数据以什么为属性名(键名)。 属性名: - Entity 以实体属性名为属性名;- Caption 以[组名-]控件名为属性名;- Id 以字段的Id为属性名;- FieldName 以字段的FieldName为属性名,默认。 |
containsAuthority | 否 | Boolean | 返回的实例数据是否包含权限: - true 包含权限,默认;- false 不包含权限。 |
请求Body 提交的实例数据放在HTTP请求的Body中,Body参数(以下参数名不区分大小写):
名称 | 是否必需 | 类型 | 描述 |
---|---|---|---|
IsSubmit | 否 | Boolean | 是否提交: - false 保存为草稿;- true 提交并生效,默认。 |
InstanceData | 是 | Object | 单据实例数据 |
AutoFillMode | 否 | String | 新建的单据实例数据是否需后台完成自动填充: - 默认空为不填充; - forceempty 填充空值(客户端未提交的或提交的值为空);- forceall 填充所有(即使客户端提交上来有值);- forceautocode 只填充关联了自动编码的字段。 |
响应
当创建成功时,HTTP 的返回是 201 Created,而 header 中的 Location 表示新的 单据实例 的 URL:
HTTP/1.1 201 Created
Location: https://api.dadayun.cn/v1/form/templates/$idOrName/instances/$instanceId
响应的body与获取单据实例相同:
- 当请求的URL查询参数带有
containsAuthority=true
或不带,返回参数参照获取单据实例(包含权限)响应参数说明 - 当请求的URL查询参数带有
containsAuthority=false
,返回参数参照获取单据实例响应参数说明
示例
请求示例
POST /v1/form/templates/Employee/instances?keyOption=Entity&containsAuthority=false HTTP/1.1
Host: api.dadayun.cn
Date: Mon, 03 Sep 2018 01:49:35 GMT
Content-Type: application/json; charset=utf-8
{
"IsSubmit": true,
"InstanceData": {
"Title": "在职_系统管理员",
"Status": "在职",
"EmployeeNumber": "NO.1",
"Name": "系统管理员",
"Gender": "男",
"Educations": [
{
"StartDate": "200809",
"EndDate": "201206",
"EduServices": "XX大学",
"Major": "软件技术",
"OrderIndex": 0
}
]
},
"AutoFillMode": "forceempty"
}
返回实例的body与获取单据实例示例相同:
- 当请求的URL查询参数带有
containsAuthority=true
或不带,返回示例参照获取单据实例(包含权限)的返回示例 - 当请求的URL查询参数带有
containsAuthority=false
,返回示例参照获取单据实例的返回示例