1. projects概述
1.1. 对象类简介:
项目,主要用于表示工程中的项目信息,既可以表示整体项目本身也可以表示大项目中出现的小项目。
可以使用通用数据管理接口实现projects对象的增、删、改、查以及关联关系的维护等操作。调用方式为将通用接口中实体对象类的类名替换为projects,关系类类名替换为projects相关的关系类。下文已举例“增加一条projects对象类实例数据”。
1.2. 对象类属性:
名称 | 类型 | 描述 | 是否必填 |
---|---|---|---|
admin | string | 管理员 | Y |
avatar | string | 项目图标 | N |
bosclass | string | class key | Y |
code | string | 项目编码 | Y |
description | string | 描述 | N |
isPrivate | string | 是否私有项目 | Y |
name | string | 名称 | Y |
status | string | 状态,表示此项目是否处于激活状态 | Y |
2. 增加一条projects对象类实例数据
创建一个projects实例。
请求方式:POST
请求地址:/bosfoundationservice/{appKey}/prototype/entity/{entity}
2.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
entity | string | projects | 是 | 对象类类名 |
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
Body:
application/json:
{
"admin": "xxxx", //管理员
"bosclass": "xxxx", //class key
"code":"xxxx", //项目编码
"isPrivate":"xxxx", //是否私有项目
"name":"xxxx", //名称
"status":"xxxx" //状态,表示此项目是否处于激活状态
}
2.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
admin | string | xxx | 是 | 管理员 |
bosclass | string | xxx | 是 | class key |
code | string | xxx | 是 | 项目编码 |
isPrivate | string | xxx | 是 | 是否私有项目 |
name | string | xxx | 是 | 名称 |
status | 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/projects
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8
Body(application/json)
{
"admin": "xxxx", //管理员
"bosclass": "xxxx", //class key
"code":"xxxx", //项目编码
"isPrivate":"xxxx", //是否私有项目
"name":"xxxx", //名称
"status":"xxxx" //状态,表示此项目是否处于激活状态
}
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/uotest/c96d7dbd877c40deae286ac87ee5faf1"
}