1. 获取{entity}对象类指定key的某种指定类型的关联实例数据
获取{entity}表指定key的某种指定类型的关联实例数据。
请求方式:GET
请求地址:/bosfoundationservice/{appKey}/prototype/entity/{entity}/{key}/relate?entityClass={entityClass}&checkChild={checkChild}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
entity | string | folders | 是 | 对象类类名 |
key | string | 33a895949c2d4c27a0973b2a162b72a9 | 是 | 对象类Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
entityClass | string | files | 是 | 与entity表关联的实体类名 |
checkChild | boolean | true/false | 是 | true表示同时查找entityClass的子类,false表示只查找entityClass |
Body:
application/json:
NULL
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
Http Status Code: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}的{bosclass}实体对象不存在 | NULL | 当{key}的entity不存在时 |
200 | BOSCLASS_NA | 不适用于{entity}类型实例数据 | NULL | 当对relationship类型操作时 |
200 | SERACHPARAS_REQUIRED | 接口路径搜索参数{serchParas}必填 | NULL | 若未传入entityClass |
200 | ENTITY_BOSCLASS_NOTFOUND | 实体类{entity}不存在 | NULL | 若entity或entityClass错误 |
200 | ENTITY_READPERMISSION_REQUIRED | 缺少实体对象{bosclass/key}的读权限 | NULL | 当对{key}的entity无操作权限时 |
200 | CLASS_READPERMISSION_REQUIRED | 缺少实体类{bosclass}的读权限 | NULL | 当实体启用了类权限,但当前用户没有类的读权限时 |
1.5. 注意事项:
1、 返回指定key实例对象及其关联的指定类型的所有实例对象的详细信息。
2、 左右对象都必须有只读权限才可显示。
3、 entity、entityClass需与返回的数据的bosclass一致,relationshipName为关系的bosclass。
4、 checkChild表示是否查找entityClass的子类,如果未指定或为true、false以外的值,则只查找entityClass
5、 entity、entityClass的关联关系可能存在于其父对象类对应的关系类中,因此需同时查找上层关系类。
6、当实体类启用了类权限时,需要当前用户对该实体类拥有读权限。