关于Liquid Content™API对GET请求的响应

Liquid Content API GET请求可以返回存储响应主体的JSON结构,也可以返回错误。

不同的因素影响响应的内容,包括:
  • GET请求的参数
  • 返回的结果数
  • 结果是否是内容类型/项
  • 内容项的内容类型

GET参数和结果计数

如果GET请求包含特定内容类型/项的ID:
  • 如果没有找到,服务器将返回404消息。
  • 如果找到了内容类型/项,则JSON结构包含关于内容类型/项的信息。
    {"id": "…",…},
如果GET请求在查询中包含参数以过滤结果,则JSON结构包含文档数组和totalResultCount
  • 如果没有发现文档数组为空。
    {"documents": [], "totalResultCount": 0}
  • 如果找到一个或多个内容类型/项,则文档数组为结果中的每个内容类型/项包含一个节点。
    {"documents": [{"id": "…",…}, {"id": "…",…}], "totalResultCount": 2}
注意:默认情况下,返回的最大结果为10。示例:如果42个内容项满足请求查询中指定的条件,则只返回10个。若要覆盖默认值,请设置maxitems在URL的查询字符串中;例如,https://dnnapi.com/content/api/ContentItems?maxitems=500

内容类型与内容项

内容类型节点与内容项节点的区别如下:

内容类型 内容项
id的名字
图标 鼻涕虫

URL中唯一标识检索内容类型的部分。

描述

contentTypeId
contentTypeName
语言

启用

如果真正的,可以为此内容类型创建内容项。

alreadyPublished

字段

每个字段节点包括字段类型、默认值、验证标准和字段在表单中的位置。

细节

字段的值。如果字段是对另一种内容类型的引用,细节包含具有该引用内容类型的字段值的节点。

currentVersion
numberOfItems

此内容类型的内容项的数目。

numberOfVisualizers

与此内容类型关联的可视化器的数量。

用法

一个内容项在其他内容项、页面或应用程序中被使用的次数。

注意:这不是内容项上的点击数。

createdAt
createdBy
updatedAt
updatedBy

isSystem

如果真正的时,内容类型为默认类型之一,不能修改或删除。

stateId

表示当前工作流状态的代码。如果为0,则该项处于草稿(未发布)模式。如果是1,则发布该项。

标签

与内容项关联的标记列表。

clientReferenceId

[string]用于与客户端同步内容项的外部标识符,特别是Evoq中的HTMLPro模块。

属性 seoSettings

内容项的类型

细节内容项的节点根据其内容类型的已定义字段而变化。

示例:假设内容类型定义包含以下两个字段。(为了清晰起见,定义进行了简化。)

内容类型定义 内容项定义
“字段”:[
"详细信息":{
{"type": "multipleChoice", "defaultValue": null, "settings": {"subType": "radioButton", "choices": [{"label": "Evoq Engage"}, {"label": "Evoq Content"}, {"label": "Evoq Basic"}, {"label": "DNN Platform"}], "multiSelect": false, "listOrientation": "vertical", "otherAsAnOption": false}, "validation":{…},“名字”:“productName”、“标签”:“产品名称”,…},
"productName": ["Evoq Content"],
{"type": " multiplecice ",…"settings": {"subType": "radioButton", "choices": [{"label": "8.5"}, {"label": "9.0"}, {"label": "9.1"}], "multiSelect": false, "listOrientation": "vertical", "otherAsAnOption": true}, "validation":{…}, "name": "version", "label": "version",…},
"version": ["9.1"],
{"type": "dateTime",…"settings": {"subType": "date", "dateFormat": "yyyymmdd", "timeFormat": "hr24", "timeZoneInfoActive": false, "timeZoneInfoId": "Dateline Standard Time"}, "validation":{…},“名字”:“releaseDate”、“标签”:“发布日期”,…},

日期和时间作为Unix时间返回。

“releaseDate”:“1493208000”,
{"type": "singleLineText",…"settings": {"subType": "url",…}, "validation":{…}, "name": "releaseNotes", "label": "Release Notes",…}
“releaseNotes”:“http://example.com”