公告管理 - Powered by MinDoc

查询公告信息
公告列表(分页条件查询)数据
删除(批量)
保存

查询公告信息

简述：

根据传入id查询，并返回公告信息

请求URL：

http://ip:port/ibps/platform/v3/system/news/get
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

名称	类型	是否必须	默认值	备注	其他信息
newsId	String	是		公告信息id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/system/news/get?newsId=650995312260808704

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": null,
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "650995312260808704",
        "title": "韩庚韩庚",
        "userName": "管理员",
        "userId": "1",
        "publicDate": "2019-12-02 00:00:00",
        "loseDate": null,
        "key": "",
        "author": "",
        "depName": "院团委",
        "depId": "631490946860580864",
        "isPublic": "N",
        "type": "",
        "typeId": "",
        "picture": "/file/getImage?attachmentId=650002046107254784",
        "fileAttach": "",
        "status": "publish",
        "publicItem": "notices",
        "content": "",
        "isIncludeChild": "Y"
    }
}

返回参数说明：

名称	类型	备注
data	NewsPo	公告对象信息

公告列表(分页条件查询)数据

简述：

公告列表(分页条件查询)数据

请求URL：

http://ip:port/ibps/platform/v3/system/news/query
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

名称	类型	是否必须	默认值	备注	其他信息
request	APIRequest^[1]	是		动态查询请求对象

请求参数示例：

{
    "parameters": [],
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    },
    "sorts": []
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": [
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "653684095783534592",
                "title": "胜多负少",
                "userName": "管理员",
                "userId": "1",
                "publicDate": "2019-12-11 00:00:00",
                "loseDate": null,
                "key": "",
                "author": "",
                "depName": "",
                "depId": "",
                "isPublic": "Y",
                "type": "",
                "typeId": "",
                "picture": "",
                "fileAttach": "",
                "status": "publish",
                "publicItem": "notices",
                "content": "",
                "isIncludeChild": "Y"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "651096661153546240",
                "title": "测试公告范围是否正常。。。",
                "userName": "管理员",
                "userId": "1",
                "publicDate": "2019-12-10 00:00:00",
                "loseDate": "2019-12-10 00:00:00",
                "key": "测试",
                "author": "管理员",
                "depName": "测试部",
                "depId": "625703010672050176",
                "isPublic": "N",
                "type": "",
                "typeId": "",
                "picture": "/file/getImage?attachmentId=651095937921318912",
                "fileAttach": "650002046107254784,646416675679240192,646664745788637184,646378672021831680",
                "status": "publish",
                "publicItem": "notices",
                "content": "<p>测试公告是否能够正常接收！！！</p><p>啦啦啦~~~啦啦</p><p>呜呜呜~~~</p>",
                "isIncludeChild": "Y"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "653600691356434432",
                "title": "发公告发公告",
                "userName": "管理员",
                "userId": "1",
                "publicDate": "2019-12-09 00:00:00",
                "loseDate": "2019-12-11 00:00:00",
                "key": "",
                "author": "秘密",
                "depName": "",
                "depId": "",
                "isPublic": "Y",
                "type": "",
                "typeId": "",
                "picture": "/file/getImage?attachmentId=653599791111995392",
                "fileAttach": "652181672011235328",
                "status": "publish",
                "publicItem": "notices",
                "content": "<p>发公告发公告发公告</p>",
                "isIncludeChild": "Y"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "651000931306962944",
                "title": "豆腐干反对",
                "userName": "管理员",
                "userId": "1",
                "publicDate": "2019-12-03 00:00:00",
                "loseDate": "2019-12-09 00:00:00",
                "key": "",
                "author": "",
                "depName": "广州流辰信息",
                "depId": "625695342267990016",
                "isPublic": "N",
                "type": "",
                "typeId": "",
                "picture": "",
                "fileAttach": "",
                "status": "expired",
                "publicItem": "notices",
                "content": "",
                "isIncludeChild": "Y"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "650995312260808704",
                "title": "韩庚韩庚",
                "userName": "管理员",
                "userId": "1",
                "publicDate": "2019-12-02 00:00:00",
                "loseDate": null,
                "key": "",
                "author": "",
                "depName": "院团委",
                "depId": "631490946860580864",
                "isPublic": "N",
                "type": "",
                "typeId": "",
                "picture": "/file/getImage?attachmentId=650002046107254784",
                "fileAttach": "",
                "status": "publish",
                "publicItem": "notices",
                "content": "",
                "isIncludeChild": "Y"
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "649998104459739136",
                "title": "二刀流",
                "userName": "ccc管理员",
                "userId": "633271888658825216",
                "publicDate": "2019-11-30 00:00:00",
                "loseDate": null,
                "key": "",
                "author": "",
                "depName": "天津大学 院团委 团支部 演示公司",
                "depId": "631490890224893952,631490946860580864,631491477834301440,641232590405107712",
                "isPublic": "no",
                "type": "",
                "typeId": "",
                "picture": "/file/getImage?attachmentId=647018162495160320",
                "fileAttach": "",
                "status": "publish",
                "publicItem": "notices",
                "content": "<p>k你哟</p>",
                "isIncludeChild": "Y"
            }
        ],
        "pageResult": {
            "limit": 20,
            "page": 1,
            "totalCount": 6,
            "totalPages": 1
        }
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< NewsPo >	公告对象信息列表

删除(批量)

简述：

批量删除公告记录

请求URL：

http://ip:port/ibps/platform/v3/msg/innerMessage/saveReply
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

名称	类型	是否必须	默认值	备注	其他信息
newsIds	String[]	是		公告信息id数组

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/system/news/remove?newsIds=651130502886981632

返回示例：

{
    "state": 200,
    "request": null,
    "message": "删除公告成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

保存

简述：

保存公告信息

请求URL：

http://ip:port/ibps/platform/v3/system/news/save
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

名称	类型	是否必须	默认值	备注	其他信息
X-Authorization-access_token	String	是		系统令牌

Query：

暂无

Body：

NewsPo对象信息：

名称	类型	是否必须	备注
id	String	是	主键
title	String	是	标题
userName	String	是	发布人
userId	String	是	发布人ID
publicDate	date	是	发布时间
loseDate	date	否	失效时间
key	String	否	关键字
author	String	否	作者
depName	String	否	发布范围组织
depId	String	否	组织ID
isPublic	String	否	是否公共:Y/N
type	String	否	类型
typeId	String	否	类型id
picture	String	否	显示图片
fileAttach	String	否	附件
status	String	否	发布状态 publish=已发布;drafts=草稿;expired=已过期
publicItem	String	否	发布选项
content	String	否	内容
isIncludeChild	String	否	是否含子集： Y-是，N-否

请求参数示例：

{
    "author": "123",
    "content": "<p>123</p>",
    "createBy": "",
    "createOrgId": "",
    "createTime": "",
    "dataStatus": "",
    "dbtype": "",
    "depId": "",
    "depName": "",
    "fileAttach": "654012082357796864",
    "id": "",
    "ip": "",
    "isPublic": "Y",
    "isIncludeChild": "Y",
    "key": "123",
    "loseDate": "2019-12-24 00:00:00",
    "name": "",
    "picture": "",
    "pk": "",
    "publicDate": "2019-12-10 00:00:00",
    "publicItem": "notices",
    "status": "publish",
    "tenantId": "",
    "title": "测试",
    "type": "",
    "typeId": "",
    "updateBy": "",
    "updateTime": "",
    "userId": "653561339549057024",
    "userName": "Jerry"
}

返回示例：

{
  "state": 200, 
  "request": null, 
  "message": "保存公告信息成功", 
  "cause": "", 
  "variables": {
    "id": "654032116979335168"
  }
}

返回参数说明：

名称	类型	备注
data	Void

文档更新时间: 2020-02-04 16:43 作者：朱业成