1. 根据实例 key 批量获取实例数据
根据实例 Key 批量获取实例数据。
请求方式:GET
请求地址:/bosfoundationservice/{appKey}/prototype/getEntityByKeys
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用 Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
entity | string | folders | 是 | 对象类类名 |
keys | string | files,documents | 是 | 实例 key 数组,以逗号间隔 |
relation | string | no/all/irFoldersFiles | 否 | 是否返回关系,no 表示不返回关联关系,all 表示返回所有关联关系,也可以指定关联关系类 |
relatedObject | boolean | true/false | 否 | 是否返回关联的对象,不填写默认为 false |
Body:
application/json:
NULL;
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
HTTP 200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": {
"parameter": {
"bosclass": "organizations",
"code": "org5",
"description": "N/A",
"isRoot": "false",
"key": "org5",
"name": "org5",
"status": "10"
},
"relationship": [
{
"relationshipName": "irOrganizationUser",
"relationshipParameter": {
"to": [
{
"bosclass": "users",
"code": "xxx",
"email": "e@123.com",
"key": "xxx",
"name": "bbbbbb",
"password": "111111",
"telephone": "12312341234",
"userKey": "user/163554068",
"username": "bbbbbb"
}
]
}
}
]
}
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | ENTITY_NOTFOUND | Key 为{key}的{entity}实体对象不存在 | NULL | 当{key}的 entity 不存在时 |
200 | BOSCLASS_NA | 不适用于{entity}类型实例数据 | NULL | 当对 relationship 类型操作时 |
200 | ENTITY_BOSCLASS_NOTFOUND | 实体类{entity}不存在 | NULL | 当传入 entity 错误时 |
200 | ENTITY_READPERMISSION_REQUIRED | 缺少实体对象{entity/key}的读权限 | NULL | 当对数据无读权限时 |
200 | CLASS_READPERMISSION_REQUIRED | 缺少实体类{bosclass}的读权限 | NULL | 当实体启用了类权限,但当前用户没有类的读权限 |
1.5. 注意事项:
1、实例数据指对象类的实例数据。
2、keys 是对象实例 key 的数组字符串,以逗号分隔。
3、relation 表示是否返回关系,no 表示不返回关联关系,all 表示返回所有关联关系,也可以指定关联关系类(可以指定多个关联关系类,以逗号分隔)。
4、relation 不是必填参数,默认为 no。
5、relatedObject 不是必填参数,默认为 false。
6、当 relation 不为 no,relatedObject 为 true,才会根据 relation 指定的关联关系类,查询对应的关联对象(如果 relation 为 all,那么就返回所有的关联关系的关联对象)。
1.6. 请求示例
请求 URL
http://bosgw.bimwinner.com/bosfoundationservice/q85e857aeb0845f19c0dcd2a426e11e0/prototype/getEntityByKeys?entity=uotest&keys=5fbce098ce1347de80494228ed57e5a7,34c646b387174b68879d88b4bf31d0b3&relation=all&relatedObject=true
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8
Body(application/json)
null
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": [
{
"parameter": {
"bosclass": "uotest",
"code": "3Op9FLe0bvdQQ0z0QqrTke",
"gcreatetime": "1596698030479",
"gtime": "1596698030479",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "5fbce098ce1347de80494228ed57e5a7"
},
"relationship": [
{
"relationshipName": "irShareObject",
"relationshipParameter": {
"from": []
}
},
{
"relationshipName": "uirtest2",
"relationshipParameter": {
"to": [
{
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"code": "1111",
"gtime": "1596707248681",
"bosclass": "uo1111",
"key": "77412deb8497445e8416f1451d150af4",
"gcreatetime": "1596707248681"
}
]
}
},
{
"relationshipName": "irProjectObject",
"relationshipParameter": {
"from": []
}
}
]
},
{
"parameter": {
"bosclass": "uotest",
"code": "3yKqGWpvIbBJ62m0NytzQY",
"gcreatetime": "1596698208788",
"gtime": "1596768680644",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "34c646b387174b68879d88b4bf31d0b3",
"testName": "test123321"
},
"relationship": [
{
"relationshipName": "irShareObject",
"relationshipParameter": {
"from": []
}
},
{
"relationshipName": "uirtest2",
"relationshipParameter": {
"to": []
}
},
{
"relationshipName": "irProjectObject",
"relationshipParameter": {
"from": []
}
}
]
}
]
}