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. 数据

区块项列表_BlockItemList

GET
/api/block-item
区块项接口

请求参数

Query 参数
siteId
integer <int64>
可选
站点ID。默认为当前站点
block
string 
区块别名
可选
blockId
integer <int64>
区块ID
可选
isAllSite
boolean 
可选
是否获取所有站点区块项列表。如：true false，默认false
isEnabled
enum<string> 
可选
是否启用。可选值：all(全部), false(禁用), true(启用)。默认值：启用
枚举值:
allfalsetrue
默认值:
true

示例代码

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/block-item'

返回响应

🟢200成功
*/*
OK
Body
array of:
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) 
文章实体类
可选
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) {3}] 
图片列表
可选
fileList
array[object (ArticleFile) {3}] 
文件列表
可选
customs
object 
自定义字段
可选
src
object (Article) 
文章实体类
可选
site
object (Site) 
站点实体类
可选
channel
object (Channel) 
栏目实体类
可选
org
object (Org) 
组织实体类
可选
user
object (User) 
用户实体类
可选
modifiedUser
object (User) 
用户实体类
可选
blockItemList
array[object (BlockItem) {18}] 
区块项列表
可选
tags
array[object (Tag) {9}] 
TAG列表
可选
destList
array[object (Article) {89}] 
引用列表
可选
file
string 
文件URL
可选
正则匹配:
^(?!.*\.\.).*$
fileName
string 
文件名称
可选
text
string 
可选
正文（HTML格式）
description
string 
可选
摘要。获取seoDescription，如不存在，则从正文中截取。最长 255 个字符（一个中文占两个字符）。
rejectReason
string 
审核拒绝原因
只读可选
source
string 
来源
可选
url
string 
URL地址
可选
articleTemplate
string 
文章独立模板
可选
正则匹配:
^(?!.*\.\.).*$
editorType
integer <int32>
正文编辑器类型
可选
markdown
string 
可选
正文（Markdown格式）
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) {24}] 
区块列表
可选
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 
作者
可选
plainText
string 
纯文本格式的正文
可选
comments
integer <int32>
评论次数
可选
block
object (Block) 
区块列表
可选
site
object (Site) 
站点实体类
可选
url
string 
URL地址
可选
示例
上一页
全文检索文章列表_EsArticleList
下一页
字典列表_DictList
Built with