1. contracts概述
1.1. 对象类简介:
合同基本信息。
可以使用通用数据管理接口实现contracts对象的增、删、改、查以及关联关系的维护等操作。调用方式为将通用接口中实体对象类的类名替换为contracts,关系类类名替换为contracts相关的关系类。下文已举例“增加一条contracts对象类实例数据”。
1.2. 对象类属性:
名称 | 类型 | 描述 | 是否必填 |
---|---|---|---|
amount | object | 合同额 | N |
bosclass | string | 对象类名称 | Y |
code | string | 编码 | Y |
contractExpDate | auto | 合同有效期 | N |
contractParty | string | 合同对方 | Y |
contractType | string | 合同类型 | Y |
name | string | 名称 | Y |
revision | string | 版本 | Y |
2. 增加一条contracts对象类实例数据
创建一个contracts实例。
请求方式:POST
请求地址:/bosfoundationservice/{appKey}/prototype/entity/{entity}
2.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
entity | string | contracts | 是 | 对象类类名 |
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
Body:
application/json:
{
"bosclass": "xxxx", //对象类名称
"code": "xxxx", //编码
"contractParty":"xxxx", //合同对方
"contractType":"xxxx", //合同类型
"name":"xxxx", //名称
"revision":"xxxx" //版本
}
2.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
bosclass | string | xxx | 是 | class key |
code | string | xxx | 是 | 编码 |
contractParty | string | xxx | 是 | 合同对方 |
contractType | string | xxx | 是 | 合同类型 |
name | string | xxx | 是 | 名称 |
revision | string | xxx | 是 | 版本 |
2.3. 正确返回:
Http Status Code:200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": "http://bosgw.bimwinner.com/bosfoundationservice/h5e4ff8257dc4e86a8042097f67d2718/prototype/entity/folders/xxxx"
}
2.4. 请求示例
请求URL
http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/contracts
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8
Body(application/json)
{
"bosclass": "xxxx", //对象类名称
"code": "xxxx", //编码
"contractParty":"xxxx", //合同对方
"contractType":"xxxx", //合同类型
"name":"xxxx", //名称
"revision":"xxxx" //版本
}
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/uotest/c96d7dbd877c40deae286ac87ee5faf1"
}