1. 获取{relationship}关系类所有实例数据
获取{relationship}中所有关系实例数据。
请求方式:GET
请求地址:/bosfoundationservice/{appKey}/prototype/edges/{relationship} 获取{relationship}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
relationship | string | irSystemTag | 是 | 关系类名 |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
withEntity | string | false | 否 | 是否返回关联关系左右对象的详细数据 |
Body:
application/json:
NULL
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
Http Status Code:200
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": [
{
"bosclass": "",
"key": "123",
"from": "",
"to": "",
XXXX
}
]
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | BOSCLASS_NA | 不适用于{relationship}类型实例数据 | NULL | 当对entity类型操作时 |
200 | RELATIONSHIP_BOSCLASS_NOTFOUND | 关系类{ relationship }不存在 | NULL | 当传入relationship错误时 |
1.5. 注意事项:
1、关系类指数据模型中配置的关系类。
2、仅返回对关系实例对应的关联实体对象有读权限的数据。
3、当withEntity为true时,from、to分别为左右对象的详细数据。
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bosfoundationservice/{appKey}/prototype/edges/uirtest2
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8
Body(application/json)
null
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": [
{
"bosclass": "uirtest2",
"key": "b6d44d109cbb423dbda2f37a78e53f22",
"from": "http://bosgw.bimwinner.com/bosfoundationservice/q85e857aeb0845f19c0dcd2a426e11e0/prototype/entity/uotest/5fbce098ce1347de80494228ed57e5a7",
"to": "http://bosgw.bimwinner.com/bosfoundationservice/q85e857aeb0845f19c0dcd2a426e11e0/prototype/entity/uo1111/77412deb8497445e8416f1451d150af4",
"gcreatetime": "1596707305561",
"gtime": "1596707305561",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d"
},
{
"bosclass": "uirtest2",
"key": "f527f5cbed13421da546cac9e7e2ae7a",
"from": "http://bosgw.bimwinner.com/bosfoundationservice/q85e857aeb0845f19c0dcd2a426e11e0/prototype/entity/uotest/85b658b499444b7b9a6248e822b89a38",
"to": "http://bosgw.bimwinner.com/bosfoundationservice/q85e857aeb0845f19c0dcd2a426e11e0/prototype/entity/uo1111/77412deb8497445e8416f1451d150af4",
"gcreatetime": "1596764725698",
"gtime": "1596764725698",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d"
}
]
}