# 新闻模块接口

# 接口调用方式

本接口为主OA Http Rest，允许被异构系统远程调用，调用前需要调用Rest接口文档 (opens new window)获取Restful token身份凭证。

# 新闻相关结构说明

新闻由多个版块构成，每个版块下有若干新闻，故新闻模块需要了解“新闻版块”和“新闻”两个对象的结构。

# 新闻版块对象示例

{
  "id" : 8683563961317344194,
  "typeName" : "单位新闻",
  "usedFlag" : true,
  "description" : null,
  "auditFlag" : true,
  "auditUser" : 0,
  "createDate" : 1395637157000,
  "createUser" : 0,
  "updateDate" : 1395637157000,
  "updateUser" : null,
  "accountId" : -5254486337235892280,
  "spaceType" : 2,
  "createUserName" : null,
  "managerUserIds" : "",
  "managerUserNames" : "",
  "writeUserIds" : null,
  "writeUserNames" : null,
  "auditUserName" : "",
  "outterPermit" : false
}

# 新闻版块属性说明

参数	说明
id	新闻版块主键
typeName	新闻版块名称
usedFlag	新闻版块是否使用
description	新闻版块描述
auditFlag	新闻版块是否审核
auditUser	新闻版块审核员ID
createDate	新闻版块创建时间
createUser	新闻版块创建人ID
updateDate	新闻版块最近更新时间
updateUser	新闻版块最近更新人ID
accountId	新闻版块所属单位ID
spaceType	新闻版块所在空间类型，3：集团 2：单位 1：部门
createUserName	新闻版块创建人名称
managerUserIds	新闻版块管理员ID，以英文逗号分隔，如：12345,67890
managerUserNames	新闻版块管理员名称，以英文逗号分隔，如：张三,李四
writeUserIds	授权此新闻版块发起新闻权限的人员ID
writeUserNames	授权此新闻版块发起新闻权限的人员名称
auditUserName	新闻版块审计管理员名称
outterPermit	新闻版块中新闻是否允许外部人员查看

# 新闻对象示例

{
  "id" : -5885266407559051539,
  "title" : "特大新闻",
  "publishDepartmentId" : 4367506212596958822,
  "brief" : null,
  "keywords" : null,
  "dataFormat" : "HTML",
  "createDate" : 1398158141000,
  "createUser" : -8361687019900091749,
  "auditDate" : null,
  "auditUserId" : null,
  "auditAdvice" : null,
  "publishDate" : 1398158141000,
  "publishUserId" : -8361687019900091749,
  "pigeonholeDate" : null,
  "pigeonholeUserId" : null,
  "pigeonholePath" : null,
  "updateDate" : null,
  "updateUser" : null,
  "readCount" : 0,
  "state" : 30,
  "deletedFlag" : false,
  "typeId" : -7855296760518983182,
  "typeName" : "行业新闻",
  "createUserName" : "张三",
  "attachmentsFlag" : false,
  "publishDepartmentName" : "平台架构部",
  "imageNews" : false,
  "focusNews" : false,
  "imageId" : null,
  "showPublishUserFlag" : false
}

# 新闻属性说明

参数	说明
id	新闻主键
title	新闻标题
publishDepartmentId	新闻发布部门
brief	新闻摘要
keywords	新闻关键字
dataFormat	新闻正文格式
createDate	新闻创建时间
createUser	新闻创建人ID
auditDate	新闻审核时间
auditUserId	新闻审核员ID
auditAdvice	新闻审核意见
publishDate	新闻发布时间
publishUserId	新闻发布者ID
pigeonholeDate	新闻归档时间
pigeonholeUserId	新闻归档者ID
pigeonholePath	新闻归档目录
updateDate	新闻最近更新时间
updateUser	新闻最近更新者
readCount	新闻阅读次数
state	新闻状态，0：草稿；10：已提交未审核；20：已审核未发布；30：已发布未归档；40：审核未通过；100：已归档
deletedFlag	新闻是否删除
typeId	新闻所在版块ID
typeName	新闻所在版块名称
createUserName	新闻创建人名称
attachmentsFlag	新闻是否有附件
publishDepartmentName	新闻发布部门名称
imageNews	是否为图片新闻
focusNews	是否为焦点新闻
imageId	新闻图片ID
showPublishUserFlag	是否显示新闻发布者

# 单位新闻版块列表

获取某一单位下的新闻版块列表。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/news/newsType/unit/{unitId}
例如：http://127.0.0.1:8088/seeyon/rest/news/newsType/unit/-7855296760518983182

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
unitId	是	单位ID

返回说明

正常情况下，会返回的是JSON格式新闻板块信息，JSON数据包参考：新闻版块对象示例

参数说明请参考:新闻版块属性说明

# 集团新闻版块列表

获取集团的新闻版块列表。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/news/newsType/group
例如：http://127.0.0.1:8088/seeyon/rest/news/newsType/group

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

根据此URI直接访问即可，无需参数。

正常情况下会返回NewsType对象的JSON格式集合ArrayList，新闻版块不存在返回null。

返回说明

正常情况下，会返回的是JSON格式新闻板块信息，JSON数据包参考：新闻版块对象示例

参数说明请参考:新闻版块属性说明

# 版块下有权限的新闻列表

获取某个版块下指定人能看到的所有新闻。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/news/newsType/{typeId}?ticket={ticket}
例如：http://127.0.0.1:8088/seeyon/rest/news/newsType/-4845296760518943182?ticket=macx

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
typeId	是	新闻版块ID
ticket	否	通过单点登录SSO成功后获取的身份令牌，这里有OA用户的身份，接口会根据这个用户的权限获取数据;如果不传ticket参数，则是获取Rest token中登录用户的身份权限获取数据；可以尝试用该集团/单位新闻管理员帐号获取最大权限

正常情况下会返回NewsData对象的JSON格式集合ArrayList，新闻不存在返回null

返回说明

正常情况下，会返回的是JSON格式新闻信息，JSON数据包参考：新闻对象示例

参数说明请参考:新闻属性说明

# 新闻列表(某单位下）

获取某个单位下的所有新闻。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/news/unit/{unitId}?ticket={ticket}&imageOrFocus={imageOrFocus}
例如：http://127.0.0.1:8088/seeyon/rest/news/unit/967547186016371000?ticket=macx&imageOrFocus=2

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
unitId	是	单位ID
ticket	是	用户的OA登录名，或使用SSO单点登录认证提取的ticket，可以尝试用该集团/单位新闻管理员帐号获取最大权限
imageOrFocus	否	新闻类型，0：图片新闻；1：焦点新闻；2：所有新闻。默认为2

返回说明

正常情况下，会返回的是JSON格式新闻List信息，JSON数据包参考：新闻对象示例

参数说明请参考:新闻属性说明

# 新增新闻(Since:V5.6)

创建新闻，如果要直接发布新闻，请取消该新闻版块审核控制，并且，当前接口不支持图片新闻。

接口请求说明：

http请求方式：POST
http://ip:port/seeyon/rest/news/

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
accountId	是	单位ID
typeId	是	新闻栏目ID
brief	是	摘要信息
imgUrl	是	图片新闻，图片信息【暂不支持】
keywords	是	关键字
publishDepartmentName	是	发起者部门名称
imageNews	是	图片新闻，图片信息【暂不支持】
imageId	是	图片新闻，图片信息【暂不支持】
senderuser	是	发送新闻人员的登录名。【新闻发起人必须是对应栏目的管理员，拥有发起权限，否则无法发起新闻】
content	是	正文信息。
contentName	是	赋值""信息。
dataFormat	是	正文类型，现阶段只支持HTML 的正文格式，赋值"HTML".
ext5	是	“”。
publishDepartmentId	是	发起人员部门ID，赋值""信息。
publishScope	是	接受新闻范围，如果是草稿状态：赋值""信息。如果直接发送，赋值例如【"Post\|6279300026643924673,Level\|-6807464151015665857"】
title	是	新闻标题
ext3	是	草稿状态：赋值"null";直接发布:赋值"0"
state	是	草稿状态：赋值"0";直接发布:赋值"30"
publishDate	是	发布日期，赋值例如"2015-06-08 17:03:09"
publishUserId	是	发布人ID赋值""
createDate	是	创建日期，赋值例如"2015-06-08 17:03:09"
ext1	是	访问记录信息赋值"0"
ext2	是	是否允许打印赋值"0 或者1"
showPublishUserFlag	是	是否显示发布人赋值"false 或者 true"
updateDate	是	更新日期，赋值例如"2015-06-08 17:03:09"
updateUser	是	更新人员ID，赋值""
readCount	是	阅读计数，赋值0
attachmentsFlag	是	附件标记，暂不支持附件，，赋值"false"

返回说明

如果发布失败返回-1，发布成功，会返回的是JSON格式新闻对象信息，JSON数据包参考：新闻对象示例

参数说明请参考:新闻属性说明

# 根据ID获取新闻(Since:V7.0)

通过ID获取新闻数据。

接口请求说明：

http请求方式：GET
http://ip:port/seeyon/rest/news/{newsId}

注：请求需要携带token，否则无法使用，获取并传递token方法参考：https://open.seeyoncloud.com/seeyonapi/781/

参数说明：

参数	是否必须	说明
newsId	是	新闻ID

返回说明

查询失败返回-1，查询成功，会返回的是JSON格式新闻信息，JSON数据包参考：新闻对象示例

参数说明请参考:新闻属性说明

编撰人：het

快速跳转

新闻模块接口

← 统一待办接口公告模块 →