更新时间:2025-08-20 GMT+08:00
分享

创建自定义对象

功能介绍

添加一个自定义对象(Object)。

URI

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

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

新建自定义对象的名称。

约束限制

创建后不可修改。

取值范围

必须以英文字母开头,只能由英文字母,数字和单下划线组成,不允许下划线结尾,且长度不能超过63个字符。

默认取值

不涉及。

label

String

参数解释

对象的别名,创建后可以修改。

约束限制

不涉及。

取值范围

1~80个字符。

默认取值

不涉及。

description

String

参数解释

对象的描述信息。

约束限制

不涉及。

取值范围

1~80个字符。

默认取值

不涉及。

fields

Array of field object

参数解释

对象的字段列表,字段参数请参见表2

约束限制

不涉及。

表2 fields字段参数

参数

是否必选

参数类型

描述

label

String

参数解释

新建字段的标签。

约束限制

不涉及。

取值范围

1~80个字符。

默认取值

不涉及。

name

String

参数解释

新建字段的名称。

约束限制

创建后不可修改。

取值范围

必须以英文字母开头,只能由英文字母,数字和单下划线组成,不允许下划线结尾,且长度不能超过63个字符。

默认取值

不涉及。

dataType

String

参数解释

新建字段的类型。

约束限制

创建后不可修改。

取值范围

  • 文本(text):允许用户输入任何字母和数字的组合,最多可输入255个字符。
  • 密文(encryptedtext):允许用户输入任何字母和数字的组合,并且以加密格式存储,最多可输入111个字符。
  • 文本区(textarea):允许用户输入多行文本,最多可输入1,048,576字符。
  • 数字(number):允许用户输入任何数字,会删除前置零。
  • 百分比(percent):允许用户输入百分比数字(例如"10"),并自动向数字添加百分号。
  • 电话(phone):允许用户输入任何电话号码,系统会自动将其转换为电话号码格式。
  • 币种金额(currency):允许用户输入其他币种金额,并将字段自动转换为币种金额格式。此功能在将数据导出到Excel或其它电子表格时非常有用。
  • 日期(date):允许用户输入日期或从弹出式日历中选择日期。
  • 日期/时间(datetime):允许用户输入日期和时间,或从弹出式日历中选择日期。当用户单击弹出式日历中的某个日期后,该日期和当前时间将输入到“日期/时间”字段。
  • 电子邮件(email):允许用户输入电子邮件地址,对其进行验证以确保格式正确。如果对一个联系人和潜在客户指定了此字段,则用户单击“发送电子邮件”时可以选择地址。自定义电子邮件地址无法用于批量电子邮件。
  • 复选框(checkbox):允许用户选择“真”(选取)或“假”(不选取)值。
  • 选项列表(singleselect):允许用户从定义的列表中选择值。
  • 选项列表(多项选择 multiselect):允许用户从定义的列表中选择多个值。
  • URL(url):允许用户输入任何有效的网址。当用户单击该字段时,该 URL 将在单独的浏览器窗口中打开。
  • 查找关系(lookup):创建一个将此对象连接到另一对象的关系。
  • 自动编号(autonumber):使用用户定义的格式生成序列编号。该编号对于每条新记录会自动递增。
  • 公式(formula):使用用户定义的公式表达式生成只读字段。任何表达式中使用的源字段有所更改,本字段值将更新。
  • 主从关系类型(masterdetail):在一个对象和另一个对象之间创建一种特殊类型的父子关系。详细记录的所有权是由主记录决定的。当用户删除主记录时,所有详细记录都将被删除。
  • 多语言(multilanguage):允许用户从自定义资源表中选择多种语言内容。
  • 附件(attachment):允许用户保存多个上传文件的地址,支持图片、文档等类型。

默认取值

不涉及。

响应参数

表3 响应参数

参数

参数类型

描述

resCode

String

参数解释

返回码。

取值范围

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

resMsg

String

参数解释

返回消息。

取值范围

成功返回“成功”,其他情况会返回具体的错误信息。

result

string

参数解释

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

取值范围

不涉及。

请求示例

创建Object对象实例。

POST https://华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Object

{
    "label": "VehicleType",
    "name": "VehicleType__CST",
    "description": "",
    "fields": [
        {
            "label": "Name",
            "name": "name",
            "dataType": "Name"
        }
    ]
}

响应示例

{
    "resCode":"0",
    "resMsg":"成功",
    "result":"cust***aKtFZpERvc"
}     

状态码

状态码请参见状态码

错误码

错误码请参见错误码

相关文档