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

删除{key}的entity实例。

请求方式:DELETE

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

1.1. 请求参数:

Headers:

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

PathParas:

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

SearchParas:

参数名 类型 示例 是否必填 参数含义
delRelation boolean true/false true表示删除所有关系;false表示不删除任何关系,如有关系存在返回错误信息
transactionCode string 3MD2XzN70VkcvbXllg7x7V 业务事务编码

Body:

application/json:

NULL

1.2. 参数说明:

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

1.3. 正确返回:

Http Status Code:200
{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": "{key}"
}
data为被删除对象的key

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_NOTFOUND Key为{key}的{entity}实体对象不存在 NULL 当{key}的entity不存在时
200 ENTITY_DELETEPERMISSION_REQUIRED 缺少实体对象{entity/key}的删除权限 NULL 当对实体对象无删除权限时
200 ENTITY_RELATIONSHIP_EXIST 实体对象{entity/key}存在关联关系 NULL 当delRelation值为false,且{key}的对象还存在关联关系时
400 RELATIONSHIP_RELATIONENTITY_PERMISSION_INSUFFICIENT 缺少对关联实体对象{bosclass/key}的读权限 NULL 当删除关系时如果对关系中另一关联实体对象无读权限
200 BOSCLASS_NA 不适用于{entity}类型实例数据 NULL 当对relationship、users或其子孙类操作时
200 ENTITY_BOSCLASS_NOTFOUND 实体类{entity}不存在 NULL 当传入entity错误时
200 CLASS_DELETEPERMISSION_REQUIRED 缺少实体类{bosclass}的删除权限 NULL 当实体启用了类权限,但当前用户没有类的删除权限时

1.5. 注意事项:

1、对象类指数据模型中配置的对象类。

2、delRelation值为true时,删除实例数据时需先删除与此实例对象关联的所有关系。

3、删除与此实例对象关联的关系时,如果存在用户没有权限删除的关系(即对关系中另一关联实体对象无读权限)时,则返回HTTP200。

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

5、不可操作users及其子孙类实体对象。

5、当实体类启用了类权限时,需要当前用户对该实体类拥删除权限。

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

results matching ""

    No results matching ""