根据object_id为Object添加字段
功能介绍
为object添加自定义字段。
URI
POST AstroZero域名/u-route/baas/metadata/v1.0/Object/{object_id}/Field
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Object_id |
是 |
String |
Object的ID,可通过调用查询所有Object对象接口查看(响应消息中的“id”)。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
字段是否可搜索。 |
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
resCode |
String |
返回码,如果返回“0”代表请求成功,其他错误码说明请参考错误码。 |
resMsg |
String |
返回消息,如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 |
result |
string |
成功返回会返回Object的一个ID值。 |
请求示例
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" }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。