更新时间:2024-11-21 GMT+08:00
分享

根据object_id新增校验规则

功能介绍

根据object_id新增对象校验器。在向对象中录入记录数据时,为了保证对象数据的有效性,可以定义一些校验规则,对字段值以及各字段之间的逻辑关系进行校验。例如,name字段不能为空,MinPrice字段不能大于maxPrice字段等。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

Object_id

String

参数解释

对象的ID值,可通过调用查询所有自定义对象接口查看(响应消息中的“id”)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body体参数

参数

是否必选

参数类型

描述

name

String

参数解释

字段校验器的名称。

约束限制

不涉及。

取值范围

必须以英文字母开头,只能由英文字母,数字和单下划线组成,没有连续的下划线,不能以单下划线结尾,且长度不能超过64个字符。

默认取值

不涉及。

label

String

参数解释

字段校验器的标签。

约束限制

不涉及。

取值范围

1~80个字符。

默认取值

不涉及。

description

String

参数解释

字段校验器的描述信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

active

String

参数解释

设置激活状态。

约束限制

如果存在该参数的情况下,会忽略其他参数,即激活/冻结时,不能同时修改其他属性。

取值范围

  • true:表示激活。
  • false:表示不激活。

默认取值

false。

errorExpression

String

参数解释

校验器判断的规则表达式。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

errorMessage

String

参数解释

错误信息,即校验失败时提示的信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

errorLocation

String

参数解释

错误信息出现的位置,当前仅支持在页面的上方显示,即topOfPage。

约束限制

不涉及。

取值范围

不涉及。

默认取值

topOfPage。

响应参数

表3 响应参数

参数

参数类型

描述

resCode

String

参数解释

返回码。

取值范围

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

resMsg

String

参数解释

返回消息。

取值范围

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

result

string

参数解释

成功返回会返回对象的一个ID值。

取值范围

不涉及。

请求示例

根据object_id新增对象校验器。
POST https://AstroZero域名/u-route/baas/metadata/v1.0/Object/cust000000aKtFZpERvc/Validator
{
  "active": true,
  "name": "age",
  "label": "age",
  "errorExpression": "age__CST>10",
  "errorMessage": "The age is greater than 10.",
  "errorLocation": "topOfPage"
}

响应示例

{
  "resCode": "0",
  "resMsg": "Success",
  "result": "001j000000SNRBr3JnOq"
} 

状态码

状态码请参见状态码

错误码

错误码请参见错误码

相关文档