文档首页> Astro轻应用 AstroZero> API参考> API> 元数据> 自定义对象的操作> 根据object_id添加字段
更新时间：2024-06-28 GMT+08:00
查看PDF
分享

根据object_id添加字段

功能介绍

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

URI

POST AstroZero域名/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

参数解释：

字段的类型。

约束限制：

创建后不可修改。

取值范围：

不涉及。

默认取值：

不涉及。

description

否

String

参数解释：

字段的描述。

约束限制：

不涉及。

取值范围：

1~80个任意字符。

默认取值：

不涉及。

defaultValue

否

String

参数解释：

默认值。

约束限制：

格式需符合“字段类型”和“字段长度”的规则。

取值范围：

不涉及。

默认取值：

不涉及。

caseSensitive

否

Boolean

参数解释：

是否大小写敏感。

约束限制：

不涉及。

取值范围：

  • true：表示大小写敏感。
  • false：表示大小写不敏感。

默认取值：

false。

isRequired

否

Boolean

参数解释：

字段是否必填。

约束限制：

不涉及。

取值范围：

  • true：表示字段必填。
  • false：表示字段不必填。

默认取值：

false。

isUnique

否

Boolean

参数解释：

字段中数据是否不重复。

约束限制：

不涉及。

取值范围：

  • true：表示字段唯一。
  • false：表示字段不唯一。

默认取值：

false。

profiles

否

Array

参数解释：

权限分配。

约束限制：

不涉及。

layouts

否

Array

参数解释：

对象字段布局页面名。

约束限制：

不涉及。

view

否

Object

参数解释：

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

约束限制：

不涉及。

isSearchable

否

Boolean

参数解释：

字段是否可搜索。

约束限制：

不涉及。

取值范围：

  • true：表示字段可搜。
  • false：表示字段不可搜索。

默认取值：

false。

响应参数

表3 响应参数

参数

参数类型

描述

resCode

String

参数解释：

返回码。

取值范围：

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

resMsg

String

参数解释：

返回消息。

取值范围：

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

result

string

参数解释：

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

取值范围：

不涉及。

请求示例

根据object_id为Object添加字段。 
POST https://AstroZero域名/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"
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。

分享：

    相关文档

    相关产品