1. 获取{entity}对象类指定的key的指定关联方向{type}的所有关联实例数据
获取对象类指定的key的指定关联方向{type}的所有关联实例数据。
请求方式:GET
请求地址:/bosfoundationservice/{appKey}/prototype/entity/{entity}/{key}/relationByType?type={type}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
entity | string | folders | 是 | 对象类类名 |
key | string | 33a895949c2d4c27a0973b2a162b72a9 | 是 | 对象类Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
type | string | from/to/all(all代表from或to) | 是 | 关联类型 |
Body:
application/json:
NULL
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": {
"parameter": {
//指定key实体信息
},
"relationship": [
{
"relationshipName": "关系类名1",
"relationshipParameter": {
"to": [//根据实际情况用to或from标识
{//关联实体信息}
]
}
},
{
"relationshipName": "关系类名2",
"relationshipParameter": {
"to": [//根据实际情况用to或from标识
{
//关联实体信息
}
]
}
}
]
}
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.5. 注意事项:
1、对象类指数据模型中配置的对象类。
2、返回指定{key}实例对象及该指定对象在关联关系中为{type}的关系实例的另一端关联实体详细信息。
3、type为from表示指定key在关系中为fromKey;type为to表示指定key在关系中为toKey;type为all表示指定key在关系中为fromKey或toKey。
4、需对左、右对象都有只读权限才可显示。
5、{entity}需与指定{key}实例对象的bosclass一致。
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bosfoundationservice/{appKey}/prototype/entity/uotest/d14255f5af0046e1970a2505b024f474/relationByType?type=all
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8
Body(application/json)
null
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"parameter": {
"bosclass": "uotest",
"code": "0NpVSRcgRvt2pUeqqxfzUv",
"currentUserPermissions": "rwdc",
"gcreatetime": "1596702817493",
"gtime": "1596702817493",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "d14255f5af0046e1970a2505b024f474",
"testName": "4"
},
"relationship": [
{
"relationshipName": "uirtest2",
"relationshipParameter": {
"to": [
{
"bosclass": "uo1111",
"code": "1111",
"gcreatetime": "1596707248681",
"gtime": "1596707248681",
"guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
"key": "77412deb8497445e8416f1451d150af4"
}
]
},
"relationshipDescription": ""
}
]
}
}