1. 创建对象类

创建对象类。

请求方式:POST

请求地址:/bosfoundationservice/{appKey}/datamodel/insert/doc

1.1. 请求参数:

Headers:

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

PathParas:

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

SearchParas:

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

Body:

application/json:

{
    "classDefinition": {
        "classDescription": "新建对象类测试", #类的描述信息
        "className": "uoTest", #必填项,类名,不可重复,对应数据的bosclass
        "objectName": "测试",#必填项,对象类别名,显示用,不可重复
        "parentKey": "base", #base表示是基类,其他为父类ClassName,不传默认base    
"collection": "uoTest", #保存实例数据的表名    
        "baseclass": "tree" #基础类型,tree-树形结构;entity-普通实体类,默认entity
    }
}

1.2. 参数说明:

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

1.3. 正确返回:

(Http Status Code:200{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "success": true,
        "attributeGroup": [],
        "_rev": "_cVzJOUa---",
        "_id": "class_object/uoTest",
        "_key": "uoTest",
        "classDefinition": {
            "baseclass": "tree",
            "type": "doc",
            "isPublic": false,
            "objectName": "测试",
            "relType": null,
            "className": "uoTest",
            "collection": "uoTest",
            "parentKey": "base",
            "classDescription": "新建对象类测试"
        }
    }
}

1.4. 错误返回:

状态码 code message data 原因
200 USER_ADMINPERMISSION_REQUIRED 当前用户非用户管理员 NULL 操作用户不是应用管理员且没有基类的编辑权限
200 OBJECT_REQUIREDFIELD_EMPTY {XXX}属性必填 NULL ClassDefinition必填字段className/objectName缺失
200 CLASSNAME_EXIST className({ClassName})已存在 NULL ClassName已存在
200 OBJECTNAME_EXIST objectName({ObjectName})已存在 NULL ObjectName已存在
200 COLLECTION_EXIST Collection({collection})已存在 NULL 创建基类的collection已存在
200 OBJECT_FIELD_DATA_WRONG baseclass属性数据错误 NULL baseclass值错误
200 CREATE_COLLECTION_FAILED 创建collection{collection}失败 NULL 创建Collection失败
200 ENTITY_BOSCLASS_NOTFOUND 实体类{parentKey}不存在 NULL parentKey父对象不存在
200 PARENT_TYPE_ERROR 父类{xxx}类型错误 NULL parentKey父对象类是关系类

1.5. 注意事项:

  1. 只有应用管理员或者具有基类编辑权限的用户可以创建实体类。
  2. 用户自定义实体类以uo开头。
  3. 创建基类默认有bosclass和code两个属性。
  4. 创建子类继承父类的所有属性和属性组。
  5. 创建子类继承父类的类权限。
  6. 创建基类如果没有传collection,collection与className相同。
  7. 创建子类collection与父类相同。
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""