本文导读

展开导读

文档首页/ 华为云Astro轻应用/ API参考/ API/ 元数据/ 自定义对象的操作/ 根据object_id添加字段

根据object_id添加字段

更新时间：2025-05-07 GMT+08:00

查看PDF

功能介绍

为自定义对象，添加所需的字段。

URI

POST 华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Object/{object_id}/Field

表1 路径参数
参数	是否必选	参数类型	描述
Object_id	是	String	参数解释：对象的ID值，可通过调用查询所有自定义对象接口查看（响应消息中的“id”）。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求body参数
参数	是否必选	参数类型	描述
name	是	String	参数解释：新增字段的名称。约束限制：创建后不可修改。取值范围：必须以英文字母开头，只能由英文字母，数字和单下划线组成，不允许下划线结尾，且长度不能超过63个字符。默认取值：不涉及。
label	是	String	参数解释：新增字段的标签。约束限制：不涉及。取值范围： 1~80个字符。默认取值：不涉及。
inlineHelpText	否	String	参数解释：新增字段的帮助说明。约束限制：不涉及。取值范围： 1~255个字符。默认取值：不涉及。
dataLength	是	Int	参数解释：新增字段的长度。约束限制：不涉及。取值范围： 1~64个字符。默认取值：不涉及。
dataType	是	String	参数解释：新增字段的类型。约束限制：创建后不可修改。取值范围：文本：允许用户输入任何字母和数字的组合，最多可输入255个字符。密文：允许用户输入任何字母和数字的组合，并且以加密格式存储，最多可输入111个字符。文本区：允许用户输入多行文本，最多可输入1,048,576字符。数字：允许用户输入任何数字，会删除前置零。百分比：允许用户输入百分比数字（例如"10"），并自动向数字添加百分号。电话：允许用户输入任何电话号码，系统会自动将其转换为电话号码格式。币种金额：允许用户输入其他币种金额，并将字段自动转换为币种金额格式。此功能在将数据导出到Excel或其他电子表格时非常有用。日期：允许用户输入日期或从弹出式日历中选择日期。日期/时间：允许用户输入日期和时间，或从弹出式日历中选择日期。当用户单击弹出式日历中的某个日期后，该日期和当前时间将输入到“日期/时间”字段。电子邮件：允许用户输入电子邮件地址，对其进行验证以确保格式正确。如果对一个联系人和潜在客户指定了此字段，则用户单击“发送电子邮件”时可以选择地址。自定义电子邮件地址无法用于批量电子邮件。复选框：允许用户选择“真”（选取）或“假”（不选取）值。选项列表：允许用户从定义的列表中选择值。选项列表（多项选择）：允许用户从定义的列表中选择多个值。 URL：允许用户输入任何有效的网址。当用户单击该字段时，该 URL 将在单独的浏览器窗口中打开。查找关系：创建一个将此对象链接到另一对象的关系。自动编号：使用用户定义的格式生成序列编号。该编号对于每条新记录会自动递增。公式：使用用户定义的公式表达式生成只读字段。任何表达式中使用的源字段有所更改，本字段值将更新。主从关系类型：在一个对象和另一个对象之间创建一种特殊类型的父子关系。详细记录的所有权是由主记录决定的。当用户删除主记录时，所有详细记录都将被删除。多语言：允许用户从自定义资源表中选择多种语言内容。附件：允许用户保存多个上传文件的地址，支持图片、文档等类型。默认取值：不涉及。
description	否	String	参数解释：新增字段的描述信息。约束限制：不涉及。取值范围： 1~80个字符。默认取值：不涉及。
defaultValue	否	String	参数解释：新增字段的默认值。约束限制：格式需符合字段类型（dataType）中所配置类型的规则。取值范围：不涉及。默认取值：不涉及。
caseSensitive	否	Boolean	参数解释：大小写是否敏感，例如，“ABC”和“abc”为相同值，表示大小写不敏感，“ABC”和“abc”为不同值，则表示大小写敏感。约束限制：不涉及。取值范围： true：表示大小写敏感。 false：表示大小写不敏感。默认取值： false。
isRequired	否	Boolean	参数解释：字段是否必填。约束限制：不涉及。取值范围： true：表示字段必填。 false：表示字段不必填。默认取值： false。
isUnique	否	Boolean	参数解释：字段中数据是否允许重复。约束限制：不涉及。取值范围： true：表示字段唯一。 false：表示字段不唯一。默认取值： false。
profiles	否	Array	参数解释：权限分配。字段级安全配置，配置每个权限对该字段是否可见/可编辑。约束限制：不涉及。
layouts	否	Array	参数解释：对象字段布局页面的名称。约束限制：不涉及。
view	否	Object	参数解释：每项为一个String数组，名为包含该字段的Layout，内容为该Layout包含的字段。约束限制：不涉及。
isSearchable	否	Boolean	参数解释：是否支持使用search语句搜索该字段。约束限制：不涉及。取值范围： true：表示字段可搜。 false：表示字段不可搜索。默认取值： false。

响应参数

表3 响应参数
参数	参数类型	描述
resCode	String	参数解释：返回码。取值范围：如果返回“0”代表请求成功，其他错误码说明请参考错误码。
resMsg	String	参数解释：返回消息。取值范围：成功返回“成功”，其他情况会返回具体的错误信息。
result	string	参数解释：成功返回会返回Object的一个ID值。取值范围：不涉及。

请求示例

根据object_id为Object添加字段。

POST https://华为云Astro轻应用域名/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"
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： 自定义对象的操作

上一篇：按照object_id查询自定义对象

下一篇：根据object_id新增触发器

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问