1. 批量增加实体数据
批量增加实体数据。
请求方式:POST
请求地址:/bosfoundationservice/{appKey}/prototype/entity-batch
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
1.2. 请求主体:
application/json:
[
{
"code": "xxxx,//对象类编码",
"relationClass": "xxx,//关系类类名",
"relationKey": "bosclass/xxx,//关联的对象类bosclass/key",
"relationKeyType": "xxx,//to或from"
},
{
"xxx": "xxx"
}
]
1.3. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
code | string | 否 | 对象类编码 | |
relationClass | string | 否 | 关系类类名 | |
relationKey | string | 否 | 关联的对象类bosclass/key | |
relationKeyType | string | 否 | xxx,#to或from |
1.4. 正确返回:
(Http Status Code:200)
[
{
"code": "SUCCESS",
"message": "请求处理成功",
"data": "http://xxx.xxx.xxx/bosfoundationservice/h5e4ff8257dc4e86a8042097f67d2718/prototype/entity/folders/xxxx"
}
]
1.5. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | BOSCLASS_NA | 不适用于{entity}类型实例数据 | NULL | 当对relationship、users及其子孙类操作 |
200 | ENTITY_NAME_INVALID | 实体对象name属性值无效 | NULL | 当name包含※时 |
200 | JSON_FORMAT_WRONG | Json格式错误 | NULL | 当传入Body格式错误时 |
200 | ENTITY_BOSCLASS_NOTFOUND | 实体类{entity}不存在 | NULL | 当传入bosclass错误时 |
200 | OBJECT_REQUIREDFIELD_EMPTY | XXX属性必填 | NULL | 当实体必填字段缺失时 |
200 | RELATIONSHIP_RELATIONENTITY_PERMISSION_INSUFFICIENT | 缺少对关联实体对象{bosclass/key}的读权限 | NULL | 当创建关系时如果对 relationKey对应的实体无读权限 |
200 | OBJECT_FIELD_DATATYPE_WRONG | 当实体字段数据类型错误(包括必填字段值为空字符串)时 | NULL | 当实体字段数据类型错误 |
200 | RELATIONSHIP_FIELD_DATATYPE_WRONG | relationKey,relationClass,relationKeyType数据类型错误 | NULL | 当传入relationClass,relationKey,relationKeyType,relationParamter为空时 |
200 | ENTITYKEY_FORMAT_WRONG | 实体对象{bosclass/key}格式错误 | NULL | 当传入relationKey数据格式错误时 |
200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当传入relationKey数据错误时 |
200 | RELATIONSHIP_RELATIONPARAMETER_REQUIREDFIELD_EMPTY | relationParameter中xxx属性必填 | NULL | 当relationParameter中缺少必填字段时 |
200 | RELATIONSHIP_RELATIONPARAMETER_DATATYPE_WRONG | relationParameter中xxx属性数据类型错误 | NULL | 当relationParameter中参数数据类型错误时 |
200 | RELATIONSHIP_DEFINITION_WRONG | relationKey,relationClass,relationKeyType内容不符合建立关联关系要求 | NULL | 当不符合建立关联关系要求时 |
200 | RELATIONSHIP_DEFINITION_INCOMPLETE | relationKey,relationClass,relationKeyType必须全部指定或全部不指定 | NULL | relationClass,relationKey,relationKeyType须全部指定或者全部不指定 |
200 | ENTITY_CODE_EXIST | 系统中已存在编码为xxx的{bosclass} | NULL | 部分创建数据失败时,则返回成功信息及失败数据错误信息 |
200 | CLASS_WRITEPERMISSION_REQUIRED | 缺少实体类{bosclass}的写权限 | NULL | 当实体启用了类权限,但当前用户没有类的写权限时 |
1.6. 注意事项:
1、对象类指数据模型中配置的对象类。
2、能满足除relationship关系类型、users实体之外的所有其他类型实例数据的创建,包括用户自定义的类型。
3、body数组中每个实体对象必须传入bosclass值,按bosclass值校验数据定义。
4、对于documents及其自定义子孙类的实体对象,如果未传递revision属性或revision属性值为空值时,则revision默认为0。
5、code如未提供或为空则由系统随机生成。
6、创建实体时可同时创建该实体的关联关系relationship,传入参数中包含需要创建的关联关系,关联关系表示方式:"relationClass":"ir**","relationKey":"document/doc-123","relationKeyType":"from或to","relationParameter":{xxxx}。以上参数中relationParameter为可选项,其它参数需要全都传或者全都不传。
7、实体的关联关系创建失败时该实体同时创建失败。
8、当实体类启用了类权限时,需要当前用户对该实体类拥有写权限。