关于液体内容™内容类型字段POST和PUT api
JSON结构在POST请求的主体要求字段
内容类型是数组,每个字段定义为字段数组中的一个节点。
字段
数组:“字段”:[…{“类型”:“singleLineText”、“defaultValue”:空,“setDefaultValueAsHidden”:假的,“设置”:{“子类型”:“单行模式”、“phoneNumberFormat”:零},“验证”:{" requireField ":{“活跃”:真的,“errorMessage”:“这是一个必需的字段”},“numberOfCharacters”:{“活跃”:假的,“rangeDefinition”:“之间”,“最低”:空,“minimumUnit”:空,“最大”:空,“maximumUnit”:空,“errorMessage”:“这个领域并不满足所需的字符数”},“standardErrorMessage”:零},“id”:“aa50984e——b459 - 4 - caa - 94 b9 - 5 - fa3a95ff082”、“名称”:“姓”、“标签”:“姓”,“descriptionActive”:假的,“描述”:“”,“tooltipActive”:假的,“提示”:“”,“行”:0,“宽度”:“一半”、“位置”:“半两”},…]
- 创建一个内容类型的UI,
- 请求(得到),从你的应用程序内容类型,
- 清理产生的JSON删除特定的值,例如id引用字段的类型和内容,
- 取代旧的值与值为新类型。
字段类型
一个字段可以是任何下列类型:
- 单行的文本
- 多行文本
- 数量
- 多项选择
- 日期/时间
- 资产
- 引用对象
- 静态文本
每种类型可能需要额外的设置。例子:一行文本类型要求子类型设置。
也看到了验证部分。
字段类型 | 代码片段(s) |
---|---|
单行的文本 | 纯文本字段:
对于一个URL /网站:
电子邮件地址:
一个电话号码:
|
多行文本 | 纯文本:
对于富文本:
|
数量 | 例子:
指定数量的设置:
显示在UI中显示的选择是:
指定范围,使用浮动无论数量设置:
|
多项选择 | 例子:
改变选择Evoq UI中显示:
指定的选项,输入的值标签设置在选择数组中。
显示选中的数量选择:
指定如何显示复选框和单选按钮(取向被忽略列表下拉列表):
允许其他作为一个选项: |
日期/时间 | 例子:
选择变化:
有效日期格式:
有效时间格式:
使用默认时区:
为指定的指定UTC时间:
指定的太平洋时区显示时间:
|
资产 | 一个图像资产:
对于一个文档资产:
|
引用对象 | 只接受一个参考:
接受多个引用:
|
静态文本 | 指定一个静态标题(headingType可以“氢气”、“”):
指定一个段落:
|
名称和标签
所有的字段都需要一个名称和一个标签。例子:
“名称”:“firstName”、“标签”:“第一名”
默认值
一个字段可以有一个默认值设置(defaultValue),这是存储为一个字符串。这个设置是必需的字段是否有默认值。
你也可以隐藏用户的默认值。然而,如果默认值是隐藏的,不得要求。
“defaultValue”: null
与一个显示的默认值:
“defaultValue”:“这是我的违约。”,“setDefaultValueAsHidden”:假的
和一个隐藏的默认值:
“defaultValue”:“这是我的违约。”,“setDefaultValueAsHidden”:真的,…“验证”:{“requireField”:{“活跃”:假的,“errorMessage”:零},},…
验证
您可以选择需要验证数据输入字段。每种字段类型需要不同的验证设置。
例如:以下设置需要一个单行的文本字段的值,但不限制可以输入的字符数:
“验证”:{“requireField”:{“活跃”:真的,“errorMessage”:“这是一个必需的字段”},“numberOfCharacters”:{“活跃”:假的,“rangeDefinition”:“之间”,“最低”:空,“minimumUnit”:空,“最大”:空,“maximumUnit”:空,“errorMessage”:“这个领域并不满足所需的字符数”},“standardErrorMessage”:零}
的验证节点可以包含以下设置。
验证设置 | 适用于字段类型 | 说明和示例 |
---|---|---|
requireField | 所有的字段类型 |
如果字段是可选的,
如果用户必须输入一个值,
|
standardErrorMessage | 所有的字段类型 |
错误消息用于所有其他错误定义的错误消息。
|
numberOfCharacters | singleLineText |
如果字段可以包含任意数量的字符,
如果必须限制数量的字符,您可以指定一个范围,最低或最高。 范围限制:如果文本必须有5 140个字符,
最低限制:如果文本必须至少有20个字符,
最大限制:如果文本必须不超过500个字符,
|
numberOfReferences | referenceObject(多引用对象) |
如果字段可以包含任意数量的引用,
如果引用的数量必须限制,您可以指定一个范围,最低或最高。 范围限制:如果字段必须引用2至5内容项,
最低限制:如果字段必须是指至少2项内容,
最大限制:如果字段必须是指不超过5项内容,
|
dropdownOrder | numberSelector |
|
dateRange | dateTime |
如果日期是不受限制,
如果日期必须被限制,您可以指定一个日期范围( 范围限制:如果日期必须介于2017-07-10和2017-07-10, “dateRange”:{“活跃”:真的,“rangeDefinition”:“之间”,“startDateTime”:“2017 - 07 - 10 t19:00:00z”、“endDateTime”:“2017 - 07 - 14 t19:00:00z”、“errorMessage”:“你的日期是不接受日期范围内。”} 开始日期限制:如果日期必须在2017-07-31之后, “dateRange”:{“活跃”:真的,“rangeDefinition”:“后”,“startDateTime”:“2017 - 07 - 31 t19:00:00z”、“endDateTime”:空,“errorMessage”:“你的日期是不接受日期范围内。”} 结束日期限制:如果日期必须在2017-07-01之前, “dateRange”:{“活跃”:真的,“rangeDefinition”:“之前”,“startDateTime”:空,“endDateTime”:“2017 - 07 - 01 t19:00:00z”、“errorMessage”:“你的日期是不接受日期范围内。”} |
timeRange | dateTime |
如果是不受限制的时候,
如果时间必须限制,您可以指定一个时间跨度( 时间限制:如果时间必须属于一个时间跨度, “timeRange”:{“活跃”:真的,“rangeDefinition”:“之间”,“startDateTime”:“09:00:00”、“endDateTime”:“19:59:00”、“errorMessage”:“你的时间不是在接受的时间范围内。”} 开始时间限制:如果时间必须在晚上九点之后, “timeRange”:{“活跃”:真的,“rangeDefinition”:“后”,“startDateTime”:“21:00:00”、“endDateTime”:“23:59:00”、“errorMessage”:“你的时间不是在接受的时间范围内。”} 结束时间限制:如果时间必须在凌晨之前, “timeRange”:{“活跃”:真的,“rangeDefinition”:“之前”,“startDateTime”:“就是”、“endDateTime”:“05:00:00”、“errorMessage”:“你的时间不是在接受的时间范围内。”}, |
用户提示
提供提示,描述字段的目的,您可以添加一个字段描述或提示。
设置 | 说明和示例 |
---|---|
描述
|
集descriptionActive来真正的 显示的值描述以下字段Evoq UI。没有描述:
描述:
|
工具提示
|
集tooltipActive来真正的 包括信息图标,显示的值工具提示当点击/挖掘Evoq UI。没有提示:
提示:
|
UI定位
一些设置需要在UI中显示正确的内容类型。画布显示字段组成的行。每一行可分为三个或四个相等的部分,每个部分包含一个字段。
设置 | 说明和示例 |
---|---|
行 | 的行编号从零开始的;因此,第一行是行0。 例子: |
宽度 | 的宽度,相对于画布的宽度。可能的值是:
注意:部门之间的行必须是一致的宽度和位置。
例子:
|
位置 | 行字段的位置。 如果行分为四个部分,可能的值是:
如果行分为三个部分,可能的值是:
注意:部门之间的行必须是一致的宽度和位置。 例子:
|
如果宽度完整的
,位置必须开始
,不允许其他领域相同的行。
“行”:0,“宽度”:“全部”、“位置”:“开始”