ujcms
  1. 数据
ujcms
  • 数据
    • 栏目列表_ChannelList
      GET
    • 栏目对象_Channel
      GET
    • 栏目对象ByAlias_Channel
      GET
    • 文章列表_ArticleList
      GET
    • 文章分页_ArticlePage
      GET
    • 文章对象_Article
      GET
    • 上一篇文章_ArticlePrev
      GET
    • 下一篇文章_ArticleNext
      GET
    • 全文检索文章分页_EsArticlePage
      GET
    • 全文检索文章列表_EsArticleList
      GET
    • 区块项列表_BlockItemList
      GET
    • 字典列表_DictList
      GET
    • 模型列表_ModelList
      GET
    • 模型对象_Model
      GET
    • Tag列表_TagList
      GET
    • Tag分页_TagPage
      GET
    • 获取Tag对象
      GET
    • 表单列表_FormList
      GET
    • 表单分页_FormPage
      GET
    • 获取表单对象
      GET
    • 站点列表_SiteList
      GET
    • 站点对象_Site
      GET
    • 投票列表_VoteList
      GET
    • 投票分页_VotePage
      GET
    • 投票对象_Vote
      GET
    • 留言列表_MessageBoardList
      GET
    • 留言分页_MessageBoardPage
      GET
    • 获取留言对象
      GET
    • 留言类型列表_MessageBoardTypeList
      GET
    • 调查问卷列表_SurveyList
      GET
    • 调查问卷分页_SurveyPage
      GET
    • 调查问卷对象_Survey
      GET
    • 文章排行榜列表_LeaderBoardList
      GET
    • 文章排行榜分页_LeaderBoardPage
      GET
  • 内容
    • 栏目接口
      • 获取栏目浏览次数
      • 获取栏目统计数据
    • 文章接口
      • 顶文章
      • 记录下载次数
      • 踩文章
      • 获取文章浏览次数
      • 获取下载参数
      • 获取文章统计数据
    • 站点接口
      • 获取站点缓冲对象，并记录浏览量
      • 获取当前站点对象。如果传递subDir参数，则通过子目录查询当前站点；否则通过当前域名获取对应站点对象，无法获取则返回默认站点
      • 获取站点缓冲对象
    • 投票接口
      • 投票
    • 留言接口
      • 提交留言
    • 调查问卷接口
      • 投票
  • 用户
    • JWT认证接口
      • 刷新TOKEN
      • 退出。一般情况下JWT无需服务器端退出。该方法主要用于记录退出日志
      • 登录
    • 注册接口
      • 用户注册
    • 密码接口
      • 更新密码
      • 重置密码
    • 会员设置接口
      • 更新个人信息
      • 更新手机号码
      • 更新邮箱地址
      • 更新个人头像
    • 用户接口
      • 用户名是否未使用
      • 用户名是否存在
      • 手机号码是否未使用
      • 手机号码是否存在
      • 邮箱地址是否未使用
      • 邮箱地址是否存在
    • 上传接口
      • avatarUpload
      • avatarCrop
  • 系统
    • 环境接口
      • 是否开启双因子登录
      • 获得当前登录用户
      • 获取当前站点列表
      • csrf 参数
      • 获取Config配置
      • 获取客户端SM2加密 public key
    • 验证码接口
      • 尝试验证码是否正确
      • 是否显示验证码。当登录错误超过指定次数后，需要输入验证码
      • 获取验证码Token
    • 短信接口
      • 发送手机短信
      • 发送邮件短信
      • 验证手机短信是否正确
      • 验证邮件短信是否正确
  • 其它
    • 访问统计接口
      • 记录访问统计接口
      • 获取在线访问者数量
  1. 数据

文章列表_ArticleList

GET
/api/article
文章接口
用于获取文章列表
[@ArticleList channel='news' limit='8'; beans]
  [#list beans as bean]
  <a href="${bean.url}">${bean.title}</a>
  [/#list]
[/@ArticleList]

请求参数

Query 参数
siteId
integer <int64>
可选
站点ID。默认为当前站点
channel
string 
可选
栏目别名。多个栏目别名可以用逗号分开，如news,sports
channelId
integer <int64>
可选
栏目ID。多个栏目ID可以用逗号分开，如23,5,89
tagId
integer <int64>
TagID
可选
beginPublishDate
string <date-time>
可选
开始发布日期。如：2008-08-01 2012-10-01 08:12:34
endPublishDate
string <date-time>
可选
结束发布日期。如：2008-08-01 2012-10-01 08:12:34
isWithImage
boolean 
可选
是否有标题图。如：true false
title
string 
标题
可选
text
string 
正文
可选
excludeId
string <int64 array>
可选
不包含的文章ID。多个用英文逗号分隔，如1,2,5
status
string <int16 array>
可选
状态。0:已发布,1:已归档,5:待发布,10:草稿,11:待审核,12:审核中,20:已删除,21:已下线,22:已退回。默认：0（已发布）
isIncludeSubChannel
boolean 
可选
是否包含子栏目的文章。如：true false，默认true
isIncludeSubSite
boolean 
可选
是否包含子站点的文章。如：true false，默认false
isAllSite
boolean 
可选
是否获取所有站点文章。如：true false，默认false
offset
integer <int32>
可选
从第几条数据开始获取。默认为0，即从第一条开始获取
limit
integer <int32>
可选
共获取多少条数据。最大不能超过1000

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.ujcms.com/api/article?siteId&channel&channelId&tagId&beginPublishDate&endPublishDate&isWithImage&title&text&excludeId&status&isIncludeSubChannel&isIncludeSubSite&isAllSite&offset&limit'

返回响应

🟢200成功
*/*
OK
Body
array of:
id
integer <int64>
文章ID
必需
srcId
integer <int64>
源文章ID
可选
siteId
integer <int64>
站点ID
必需
orgId
integer <int64>
组织ID
必需
channelId
integer <int64>
栏目ID
必需
userId
integer <int64>
创建用户ID
必需
modifiedUserId
integer <int64>
修改用户ID
必需
created
string <date-time>
创建日期
必需
modified
string <date-time>
修改日期
必需
publishDate
string <date-time>
发布日期
必需
onlineDate
string <date-time>
上线日期
可选
offlineDate
string <date-time>
下线日期
可选
sticky
integer <int32>
置顶
必需
stickyDate
string <date-time>
置顶时间
可选
withImage
boolean 
是否有图片
必需
inputType
integer <int32>
必需
录入类型(0:常规,1:投稿,2:采集,3:接口,4:站内推送,5:站群推送)
type
integer <int32>
必需
类型(0:常规,1:复制,2:映射,3:引用)
status
integer <int32>
必需
状态(0:已发布,1:已归档,5:待发布,10:草稿,11:待审核,12:审核中,20:已删除,21:已下线,22:已退回)
order
integer <int64>
排列顺序
必需
taskId
string 
任务ID
可选
imageList
array[object (ArticleImage_List) {3}] 
图片列表
可选
name
string 
图片名称
可选
description
string 
图片描述
可选
url
string 
图片URL
必需
fileList
array[object (ArticleFile_List) {3}] 
文件列表
可选
name
string 
文件名称
必需
url
string 
文件URL
必需
length
integer <int64>
文件大小
必需
customs
object 
自定义字段
可选
额外字段
object 
可选
src
object (Article_List) 
文章实体类
可选
site
object (Site_List) 
站点实体类
可选
id
integer <int64>
站点ID
必需
parentId
integer <int64>
上级站点ID
可选
orgId
integer <int64>
组织ID
必需
modelId
integer <int64>
模型ID
必需
name
string 
名称
必需
description
string 
描述
可选
protocol
string 
必需
协议(http,https)
domain
string 
域名
必需
正则匹配:
^(?!(uploads|templates|WEB-INF|cp)$)[a-z0-9-.]*
subDir
string 
子目录
可选
正则匹配:
^(?!(uploads|templates|WEB-INF|cp)$)[\w-]*
theme
string 
主题
必需
mobileTheme
string 
手机端主题
必需
pageSize
integer <int32>
每页条数
必需
logo
string 
LOGO
可选
seoTitle
string 
SEO标题
可选
seoKeywords
string 
SEO关键词
可选
seoDescription
string 
SEO描述
可选
staticFile
string 
静态页文件
可选
mobileStaticFile
string 
手机端静态页文件
可选
editorSettings
string 
编辑器设置
可选
status
integer <int32>
必需
状态(0:正常,1:关闭)
depth
integer <int32>
层级
必需
order
integer <int32>
排列顺序
必需
views
integer <int64>
浏览次数
必需
selfViews
integer <int64>
首页浏览次数
必需
todayViews
integer <int32>
今日浏览次数
必需
yesterdayViews
integer <int32>
昨日浏览次数
必需
maxViews
integer <int32>
最高浏览次数
必需
maxDate
string <date-time>
最高浏览日期
必需
mainsJson
string 
可选
自定义主字段JSON
clobsJson
string 
可选
自定义大字段JSON
customs
object 
自定义字段
可选
watermark
object (Site.Watermark_List) 
水印设置
可选
html
object (Site.Html_List) 
静态页配置
可选
messageBoard
object (Site.MessageBoard_List) 
留言板设置
可选
editor
object 
可选
copyFromId
integer <int64>
复制站点ID
可选
copyData
array[string]
复制数据
可选
hasChildren
boolean 
是否有子站点
可选
parent
object (Site_List) 
站点实体类
可选
org
object (Org_List) 
组织实体类
可选
model
object (Model_List) 
模型实体类
可选
enabled
boolean 
可选
url
string 
URL地址
可选
filesPath
string 
可选
模板文件路径。如：/templates/1/default/_files
api
string 
可选
API 接口地址。如：{@code /contextPath/frontend}
mobileStaticUrl
string 
可选
手机端静态URL地址
dynamicUrl
string 
动态URL地址
可选
staticUrl
string 
静态URL地址
可选
normalStaticUrl
string 
可选
PC端静态URL地址
dy
string 
可选
动态地址，含部署路径、子目录，不含域名、端口。如：{@code /contextPath/subDir}
names
array[string]
可选
站点层级名称。从一级栏目到当前栏目的名称列表
template
string 
可选
staticBase
string 
可选
paths
array[object (Site_List) {58}] 
可选
站点层级。从一级站点到当前站点的列表
disabled
boolean 
可选
htmlEnabled
boolean 
可选
title
string 
可选
标题。先获取SeoTitle，如不存在则获取网站名称
targetBlank
boolean 
是否新窗口打开
可选
channel
object (Channel_List) 
栏目实体类
可选
id
integer <int64>
栏目ID
必需
siteId
integer <int64>
站点ID
必需
parentId
integer <int64>
上级栏目ID
可选
channelModelId
integer <int64>
栏目模型ID
必需
articleModelId
integer <int64>
文章模型ID
必需
performanceTypeId
integer <int64>
绩效类型ID
可选
name
string 
名称
必需
alias
string 
别名
必需
正则匹配:
^[\w-]*$
type
integer <int32>
必需
类型(1:常规栏目,2:单页栏目,3:转向链接,4:链接到第一个子栏目)
articleTemplate
string 
文章模板
可选
正则匹配:
^(?!.*\.\.).*$
channelTemplate
string 
栏目模板
可选
正则匹配:
^(?!.*\.\.).*$
image
string 
图片
可选
linkUrl
string 
转向链接
可选
正则匹配:
^(http|/).*$
processKey
string 
流程标识
可选
targetBlank
boolean 
是否新窗口打开
必需
nav
boolean 
是否导航菜单
必需
pageSize
integer <int32>
每页条数
必需
orderDesc
boolean 
是否倒序排序
必需
allowComment
boolean 
是否允许评论
必需
allowContribute
boolean 
是否允许投稿
必需
allowSearch
boolean 
是否允许搜索
必需
created
string <date-time>
创建日期
必需
modified
string <date-time>
修改日期
必需
depth
integer <int32>
层级
必需
order
integer <int32>
排列顺序
必需
views
integer <int64>
浏览次数
必需
selfViews
integer <int64>
栏目页浏览次数
必需
mainsJson
string 
可选
自定义主字段JSON
clobsJson
string 
可选
自定义大字段JSON
customs
object 
自定义字段
可选
hasChildren
boolean 
是否有子栏目
可选
children
array[object (Channel_List) {46}] 
可选
子栏目列表。只有在单独查询栏目对象时，才有此属性；查询栏目列表时，此属性为null
parent
object (Channel_List) 
栏目实体类
可选
site
object (Site_List) 
站点实体类
可选
channelModel
object (Model_List) 
模型实体类
可选
articleModel
object (Model_List) 
模型实体类
可选
performanceType
object (PerformanceType_List) 
可选
description
string 
可选
描述。获取seoDescription
url
string 
URL地址
可选
keywords
string 
可选
关键词。获取seoKeywords
dynamicUrl
string 
动态URL地址
可选
staticUrl
string 
可选
names
array[string]
可选
栏目层级名称。从一级栏目到当前栏目的名称列表。只有在单独查询栏目对象时，才有此属性；查询栏目列表时，此属性只包含当前栏目名称
paths
array[object (Channel_List) {46}] 
可选
栏目层级。从一级栏目到当前栏目的列表。只有在单独查询栏目对象时，才有此属性；查询栏目列表时，此属性只包含当前栏目
link
boolean 
是否链接
可选
title
string 
可选
标题。获取seoTitle，如不存在，则获取栏目名称
org
object (Org_List) 
组织实体类
可选
user
object (User_List) 
用户实体类
可选
id
integer <int64>
用户ID
必需
groupId
integer <int64>
用户组ID
必需
orgId
integer <int64>
组织ID
必需
username
string 
用户名
必需
email
string 
电子邮箱
可选
mobile
string 
手机号码
可选
alias
string 
博客地址
可选
nickname
string 
昵称
可选
realName
string 
真实姓名
可选
gender
integer <int32>
必需
性别(0:保密,1:男,2:女)
avatar
string 
头像URL
可选
passwordModified
string <date-time>
密码修改时间
必需
rank
integer <int32>
等级
必需
type
integer <int32>
必需
类型(1:系统管理员,2:安全管理员,3:审计管理员,4:常规管理员,5:前台会员)
status
integer <int32>
必需
状态(0:正常,1:未激活,2:已锁定,3:已注销)
group
object (Group_List) 
用户组实体类
可选
org
object (Org_List) 
组织实体类
可选
roleList
array[object (Role_List) {19}] 
角色列表
可选
orgList
array[object (Org_List) {11}] 
扩展组织列表
可选
name
string 
可选
用户名和用户真实姓名
location
string 
居住地
可选
created
string <date-time>
创建日期
可选
enabled
boolean 
是否正常状态
可选
root
boolean 
可选
是否超级管理员。ID为1的用户为超级管理员
loginDate
string <date-time>
最后登录日期
必需
loginCount
integer <int32>
登录次数
必需
loginIp
string 
最后登录IP
必需
largeAvatar
string 
大头像
可选
mediumAvatar
string 
中头像
可选
birthday
string <date-time>
出生日期
可选
bio
string 
自我介绍
可选
homepage
string 
个人主页
可选
smallAvatar
string 
小头像
可选
modifiedUser
object (User_List) 
用户实体类
可选
blockItemList
array[object (BlockItem_List) {18}] 
区块项列表
可选
id
integer <int64>
区块项ID
必需
siteId
integer <int64>
站点ID
必需
blockId
integer <int64>
区块ID
必需
articleId
integer <int64>
文章ID
可选
title
string 
标题
必需
subtitle
string 
副标题
可选
description
string 
描述
可选
linkUrl
string 
转向链接
可选
正则匹配:
^(http|/).*$
image
string 
图片
可选
mobileImage
string 
手机端图片
可选
video
string 
视频
可选
targetBlank
boolean 
是否新窗口打开
必需
enabled
boolean 
是否启用
必需
order
integer <int64>
排列顺序
必需
article
object (Article_List) 
文章实体类
可选
block
object (Block_List) 
区块实体类
可选
site
object (Site_List) 
站点实体类
可选
url
string 
URL地址
可选
tags
array[object (Tag_List) {9}] 
TAG列表
可选
id
integer <int64>
TagID
必需
siteId
integer <int64>
站点ID
必需
userId
integer <int64>
创建用户ID
必需
name
string 
名称
必需
description
string 
描述
可选
created
string <date-time>
创建时间
必需
refers
integer <int32>
引用数量
必需
user
object (User_List) 
用户实体类
可选
site
object (Site_List) 
站点实体类
可选
file
string 
文件URL
可选
正则匹配:
^(?!.*\.\.).*$
fileName
string 
文件名称
可选
description
string 
可选
摘要。获取seoDescription，如不存在，则从正文中截取。最长 255 个字符（一个中文占两个字符）。
rejectReason
string 
审核拒绝原因
只读可选
source
string 
来源
可选
url
string 
URL地址
可选
articleTemplate
string 
文章独立模板
可选
正则匹配:
^(?!.*\.\.).*$
editorType
integer <int32>
正文编辑器类型
可选
allowComment
boolean 
是否允许评论
可选
video
string 
视频URL
可选
正则匹配:
^(?!.*\.\.).*$
videoTime
string 
可选
视频时长。字符串格式，如：20:15
audio
string 
音频URL
可选
正则匹配:
^(?!.*\.\.).*$
audioDuration
integer <int32>
音频时长
可选
videoDuration
integer <int32>
视频时长
可选
audioOrig
string 
源音频URL
可选
正则匹配:
^(?!.*\.\.).*$
audioTime
string 
可选
音频时长。字符串格式，如：20:15
fileSize
string 
可选
文件尺寸。自动使用合适的单位，如 KB、MB 等
blocks
array[object (Block_List) {24}] 
区块列表
可选
id
integer <int64>
区块ID
必需
siteId
integer <int64>
站点ID
可选
name
string 
名称
必需
alias
string 
别名
必需
正则匹配:
^[一-龥\w-]*$
scope
integer <int32>
必需
共享范围(0:本站私有,1:子站点共享,2:全局共享)
withLinkUrl
boolean 
是否有URL链接
必需
withSubtitle
boolean 
是否有副标题
必需
withDescription
boolean 
是否有摘要
必需
withImage
boolean 
是否有图片
必需
withMobileImage
boolean 
是否有手机端图片
必需
withVideo
boolean 
是否有视频
必需
linkUrlRequired
boolean 
URL链接是否必填
必需
subtitleRequired
boolean 
副标题是否必填
必需
descriptionRequired
boolean 
摘要是否必填
必需
imageRequired
boolean 
图片是否必填
必需
mobileImageRequired
boolean 
手机图片是否必填
必需
videoRequired
boolean 
视频是否必填
必需
imageWidth
integer <int32>
图片宽度
必需
imageHeight
integer <int32>
图片高度
必需
mobileImageWidth
integer <int32>
手机端图片宽度
必需
mobileImageHeight
integer <int32>
手机端图片高度
必需
recommendable
boolean 
是否可推荐
必需
enabled
boolean 
是否启用
必需
order
integer <int32>
排列顺序
必需
videoOrig
string 
源视频URL
可选
正则匹配:
^(?!.*\.\.).*$
editable
boolean 
是否可编辑
可选
docName
string 
文库名称
可选
doc
string 
文库URL
可选
正则匹配:
^(?!.*\.\.).*$
baiduPush
boolean 
是否推送到百度
只读可选
fileLength
integer <int64>
文件长度
可选
yearViews
integer <int64>
年浏览次数
可选
quarterViews
integer <int32>
季浏览次数
可选
monthViews
integer <int32>
月浏览次数
可选
docOrig
string 
源文库URL
可选
正则匹配:
^(?!.*\.\.).*$
favorites
integer <int32>
收藏次数
可选
dayViews
integer <int32>
日浏览次数
可选
docLength
integer <int64>
文库长度
可选
weekViews
integer <int32>
周浏览次数
可选
articleStaticPath
string 
文章独立静态路径
可选
正则匹配:
^(?!.*\.\.)[\w-{}/]*$
editor
string 
编辑
可选
seoKeywords
string 
SEO关键字
可选
dynamicUrl
string 
动态URL地址
可选
views
integer <int64>
浏览次数
可选
template
string 
文章模板
可选
processInstanceId
string 
流程实例ID
只读可选
alias
string 
别名
可选
正则匹配:
^[\w-]*$
seoDescription
string 
SEO描述
可选
fullTitle
string 
完整标题
可选
targetBlank
boolean 
是否新窗口打开
可选
image
string 
图片URL
可选
正则匹配:
^(?!.*\.\.).*$
title
string 
标题
可选
linkUrl
string 
跳转链接
可选
正则匹配:
^(http|/).*$
subtitle
string 
副标题
可选
normal
boolean 
可选
是否正常状态（可访问）
link
boolean 
是否是链接
可选
downloads
integer <int32>
下载次数
可选
ups
integer <int32>
顶次数
可选
downs
integer <int32>
踩次数
可选
author
string 
作者
可选
comments
integer <int32>
评论次数
可选
示例
修改于 2025-03-07 08:48:13
上一页
栏目对象ByAlias_Channel
下一页
文章分页_ArticlePage
Built with