1. 获取{entity}对象类指定的key实例数据

获取{entity}表指定key数据。

请求方式:GET

请求地址:/bosfoundationservice/{appKey}/prototype/entity/{entity}/{key}?noRelation={noRelation}

1.1. 请求参数:

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea access_Token

PathParas:

参数名 类型 示例 是否必填 参数含义
entity string folders 对象类类名
key string 123 对象Key

SearchParas:

参数名 类型 示例 是否必填 参数含义
noRelation boolean true/false true表示不返回关联关系,false表示返回所有关联关系

Body:

application/json:

NULL

1.2. 参数说明:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

1.3. 正确返回:

HTTP 200
{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": {}//返回数据内容
}

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、当noRelation为false时,仅返回用户有权限获取的关联关系。

3、noRelation如若未传默认值为false,如若参数值非法按默认值为false处理。

4、当实体类启用了类权限时,需要当前用户对该实体类拥有读权限。

版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""