文档首页> 应用魔方 AppCube> API参考> API> 元数据> Object对象的操作> 根据object_id为Object添加字段
更新时间:2022-04-27 GMT+08:00
分享

根据object_id为Object添加字段

功能介绍

为object添加自定义字段。

URI

POST AppCube域名/u-route/baas/metadata/v1.0/Object/{object_id}/Field

参数说明请参见表1

表1 参数说明

参数

是否必选

参数类型

描述

Object_id

String

Object的ID

请求参数

表2 请求body参数

参数

是否必选

参数类型

描述

name

String

字段名称。

label

String

字段标签。

inlineHelpText

String

字段帮助说明。

dataLength

Int

字段长度,1~255。

dataType

String

字段类型。

description

String

字段描述。

defaultValue

String

默认值。

caseSensitive

Boolean

是否大小写敏感。

isRequired

Boolean

字段是否必填。

isUnique

Boolean

字段中数据是否不重复。

profiles

Object

权限分配。

layouts

String

对象字段布局页面名。

view

Object

每项为一个string数组,名为包含该字段的Layout,内容为该layout包含的字段。

isSearchable

Boolean

改字段是否可搜索。

响应参数

响应参数如表3所示。

表3 响应参数

参数

参数类型

描述

resCode

String

返回码,如果返回“0”代表请求成功,其他错误码说明请参考错误码

resMsg

String

返回消息,如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。

result

string

成功返回会返回Object的一个ID值。

请求示例

根据object_id为Object添加字段。
POST https://AppCube域名/u-route/baas/metadata/v1.0/Object/cust000000aKoa6I4E6K/Field
{
    "label":"test",
    "name":"CNAME1__test__CST",
    "inlineHelpText":"dsf",
    "description":"fsdf",
    "dataType":"text",
    "dataLength":255,
    "defaultValue":"vfdsg",
    "caseSensitive":true,
    "isRequired":true,
    "isUnique":true,
    "isSearchable":true,
    "profiles":[
        {
            "profile":"000T0000000000000002",
            "readable":true,
            "editable":true
        },
        {
            "profile":"000T0000000000000003",
            "readable":true,
            "editable":true
        },
        {
            "profile":"000T0000000000000004",
            "readable":true,
            "editable":true
        },
        {
            "profile":"000T0000000000000006",
            "readable":true,
            "editable":true
        },
        {
            "profile":"000T000000Tiq6fUQhjK",
            "readable":true,
            "editable":true
        },
        {
            "profile":"000T000000Tiq6lJCs2y",
            "readable":true,
            "editable":true
        },
        {
            "profile":"000T000000W1a8iTFglU",
            "readable":true,
            "editable":true
        }
    ],
    "layouts":[
        "000D000000aKoa6OJOxk"
    ],
    "view":{
        "000D000000aKoa6OJOxk":{
            "fields":[
                "name",
                "test__df__CST",
                "test__sdadsd__CST",
                "test__sdd__CST"
            ]
        }
    }
}    

响应示例

{
  "resCode":"0",
  "resMsg":"成功",
  "result":"cust000000iY8i3Jvyng"
}

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

close