1. 增加一条{entity}对象类实例数据(支持创建多个关系)

创建一个entity实例,支持创建多个关系。

请求方式:POST

请求地址:/bosfoundationservice/{appKey}/prototype/entity/relations-batch?entity={bosclass}

1.1. 请求参数:

Headers:

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

PathParas:

参数名 类型 示例 是否必填 参数含义
entity string xb05cd3a35614caa85c0f8f86c58fcc1 对象类类名

SearchParas:

参数名 类型 示例 是否必填 参数含义
transactionCode string 3MD2XzN70VkcvbXllg7x7V 业务事务编码

Body:

application/json:

{
    "code":"xxxx", //实体属性
    "grelationship":[
  {
        "relationClass":xxx,
        "relationKey":xxx,
        "relationKeyType":xxx,
        ...
     },
     ...
]
 }
}

1.2. 参数说明:

参数名 类型 示例 是否必填 参数含义
code string xxxx 实体属性

1.3. 正确返回:

(Http Status Code:200{"code":"SUCCESS","message":"请求处理成功","data":"http://xxx.xxx.xxx/bosfoundationservice/h5e4ff8257dc4e86a8042097f67d2718/prototype/entity/folders/xxxx"}

1.4. 状态码:

状态码 code message data 原因
200 "OBJECT_REQUIREDFIELD_EMPTY” "XXX 属性必填" NULL 实体必填字段缺失
200 "ENTITY_NAME_INVALID" "实体对象 name 属性值无效" NULL name 包含※
200 "OBJECT_FIELD_DATATYPE_WRONG " "XXX 属性数据类型错误" NULL 当字段数据类型错误(包括必填字段值为空字符串)时
200 RELATIONSHIP_RELATIONENTITY_PERMISSION_INSUFFICIENT "缺少对关联实体对象{bosclass/key}的读权限" NULL 当创建关系时如果对 relationKey对应的实体无读权限
200 "BOSCLASS_NA" "不适用于{entity}类型实例数据" NULL 当对relationship、users或其子孙类操作时
200 "JSON_FORMAT_WRONG" "Json 格式错误" NULL 当传入body格式错误时
200 "ENTITY_BOSCLASS_NOTFOUND" "实体类{entity}不存在" NULL 传入 entity 错误
200 RELATIONSHIP_FIELD_DATATYPE_WRONG "rrelationKey,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 "CLASS_WRITEPERMISSION_REQUIRED" "缺少实体类{bosclass}的写权限" NULL 当实体启用了类权限,但当前用户没有类的写权限时

1.5. 注意事项:

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

2、 能满足除关系类型、users实体之外的所有其他类型实例数据的创建,包括用户自定义的类型。

3、 根据entity类型的不同,把实例数据存放到不同的数据表中。用户自定义类型的数据存放到基类数据表中。

4、 能根据entity类型的定义,校验传入数据的有效性和合规性进行校验。

5、 根据{entity}参数来判断数据类型,在body中不传递bosclass属性。

6、 {entity}既可以是系统提供的基类,也可以是用户由基类继承的自定义类型。

7、 对body中传入的不在{entity}中定义的属性,忽略不作处理。

8、 对于documents及其自定义子孙类的实体对象,如果未传递revision属性或revision属性值为空值时,则revision默认为0。

9、 code如未提供或为空则由系统随机生成。

10、创建实体时可同时创建该实体的关联关系,传入参数中包含需要创建的关联关系,关联关系表示方式:"relationClass":"ir**","relationKey":" documents/doc-123_0","relationKeyType":"from或to","relationParameter":{xxxx}。以上参数中relationParameter为可选项,其它参数需要全都传或者全都不传。

11、当实体或关系创建不成功时,整个接口不执行。

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

1.6. 请求示例

请求URL

http://bosgw.bimwinner.com/bosfoundationservice/{appKey}/prototype/entity/relations-batch?entity=uotest

Headers

Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8

Body(application/json)

{
    "testName": "777", // 实体数据
    "grelationship": [
        {
            "relationClass": "uirtest2", // 关系类bosclass
            "relationKey": "uo1111/77412deb8497445e8416f1451d150af4", // 关联对象bosclass/key
            "relationKeyType": "to" // to或from
        }
    ]
}

正常响应 200

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": "http://bosgw.bimwinner.com/bosfoundationservice/q85e857aeb0845f19c0dcd2a426e11e0/prototype/entity/uotest/558ba7bfa2c54f29a4c520b86b0893fb"
}
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""