目录搜索

暂无相关搜索结果！

本文档使用 MinDoc 发布

桌面布局管理

查询布局管理信息
获取布局管理信息 // TODO 传参有点问题
桌面布局管理列表(分页条件查询)数据
桌面布局管理列表(分页条件查询)数据
删除
保存
备注

查询布局管理信息

简述：

根据传入id查询，并返回桌面布局管理信息

请求URL：

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

请求方式：

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
desktopManageId	String	是		桌面布局管理id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/desktop/manage/get?desktopManageId=654991648391954432

返回示例：

{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "桌面布局组",
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "654991648391954432",
        "memo": "桌面布局",
        "groupId": "654991203359522816",
        "templateHtml": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"b83c6bcd-db18-419a-9817-48599dd5fe78\",\"alias\":\"userInfo\",\"moved\":false},{\"x\":12,\"y\":0,\"w\":12,\"h\":10,\"i\":\"fd6bc5ce-de09-45af-bdf2-87f44100ff1d\",\"alias\":\"unreadMessage\",\"moved\":false},{\"x\":0,\"y\":10,\"w\":12,\"h\":10,\"i\":\"db83d4fc-d19c-4538-8da3-0a937342a991\",\"alias\":\"pendingMatters\",\"moved\":false}]",
        "designHtml": null,
        "isDef": "Y",
        "groupName": "桌面布局组."
    }
}

返回参数说明：

名称	类型	备注
data	DesktopManagePo	DesktopManagePo

获取布局管理信息 // TODO 传参有点问题

简述：

获取布局管理信息

请求URL：

http://ip:port/ibps/platform/v3/desktop/manage/getLayout
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
desktopManageId	String	是		桌面栏目id
columnList	List< DesktopColumnPo >	是		栏目信息列表

Body：

暂无

请求参数示例：

// TODO

返回示例：

// TODO

返回参数说明：

名称	类型	备注
data	DesktopManagePo	桌面布局管理实体对象

桌面布局管理列表(分页条件查询)数据

简述：

桌面布局管理列表(分页条件查询)数据

请求URL：

http://ip:port/ibps/platform/v3/desktop/manage/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": "整体布局",
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "666657313506983936",
                "memo": "",
                "groupId": null,
                "templateHtml": "[{\"x\":0,\"y\":50,\"w\":12,\"h\":10,\"i\":\"b659de62-1853-4f03-842c-04be4a060bcd\",\"alias\":\"myFavorites\",\"moved\":false},{\"x\":12,\"y\":50,\"w\":12,\"h\":10,\"i\":\"3d8ab416-e5a5-46b5-9d04-b5dd39ecbcff\",\"alias\":\"taskChange\",\"moved\":false},{\"x\":0,\"y\":40,\"w\":12,\"h\":10,\"i\":\"e81b505a-3913-44e8-9878-a2e87eb65108\",\"alias\":\"userInfo\",\"moved\":false},{\"x\":12,\"y\":40,\"w\":12,\"h\":10,\"i\":\"ce82f802-7c64-43fb-b5f2-c6d6b9cf869f\",\"alias\":\"unreadMessage\",\"moved\":false},{\"x\":0,\"y\":30,\"w\":12,\"h\":10,\"i\":\"9ac48c69-3840-4e8f-a1aa-694da494d8d8\",\"alias\":\"pendingMatters\",\"moved\":false},{\"x\":12,\"y\":30,\"w\":12,\"h\":10,\"i\":\"62bee36d-9412-4198-a91d-c37a78270139\",\"alias\":\"notice\",\"moved\":false},{\"x\":0,\"y\":20,\"w\":12,\"h\":10,\"i\":\"b867c5d2-3b83-4ecd-a517-f8aab3b446ba\",\"alias\":\"alreadyMatters\",\"moved\":false},{\"x\":12,\"y\":20,\"w\":12,\"h\":10,\"i\":\"d4c23348-2443-4e84-af8c-04204fdf8461\",\"alias\":\"completedMatters\",\"moved\":false},{\"x\":0,\"y\":10,\"w\":12,\"h\":10,\"i\":\"8dfd131a-120e-44dd-995c-c54f65a494c6\",\"alias\":\"myCompleted\",\"moved\":false},{\"x\":12,\"y\":10,\"w\":12,\"h\":10,\"i\":\"4aba3afc-6ccc-4fa1-977d-39fa2a07393d\",\"alias\":\"myRequest\",\"moved\":false},{\"x\":12,\"y\":0,\"w\":12,\"h\":10,\"i\":\"ffe00776-ab90-4e1c-a8c9-868d0c6119f2\",\"alias\":\"newProcess\",\"moved\":false},{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"f6825a71-3373-4c51-8322-3787b1766fb2\",\"alias\":\"dashboard\",\"moved\":false}]",
                "designHtml": null,
                "isDef": "Y",
                "groupName": null
            },
            {
                "pk": "",
                "name": "整体布局",
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "666657262068039680",
                "memo": "",
                "groupId": null,
                "templateHtml": "[{\"x\":0,\"y\":50,\"w\":12,\"h\":10,\"i\":\"b659de62-1853-4f03-842c-04be4a060bcd\",\"alias\":\"myFavorites\",\"moved\":false},{\"x\":12,\"y\":50,\"w\":12,\"h\":10,\"i\":\"3d8ab416-e5a5-46b5-9d04-b5dd39ecbcff\",\"alias\":\"taskChange\",\"moved\":false},{\"x\":0,\"y\":40,\"w\":12,\"h\":10,\"i\":\"e81b505a-3913-44e8-9878-a2e87eb65108\",\"alias\":\"userInfo\",\"moved\":false},{\"x\":12,\"y\":40,\"w\":12,\"h\":10,\"i\":\"ce82f802-7c64-43fb-b5f2-c6d6b9cf869f\",\"alias\":\"unreadMessage\",\"moved\":false},{\"x\":0,\"y\":30,\"w\":12,\"h\":10,\"i\":\"9ac48c69-3840-4e8f-a1aa-694da494d8d8\",\"alias\":\"pendingMatters\",\"moved\":false},{\"x\":12,\"y\":30,\"w\":12,\"h\":10,\"i\":\"62bee36d-9412-4198-a91d-c37a78270139\",\"alias\":\"notice\",\"moved\":false},{\"x\":0,\"y\":20,\"w\":12,\"h\":10,\"i\":\"b867c5d2-3b83-4ecd-a517-f8aab3b446ba\",\"alias\":\"alreadyMatters\",\"moved\":false},{\"x\":12,\"y\":20,\"w\":12,\"h\":10,\"i\":\"d4c23348-2443-4e84-af8c-04204fdf8461\",\"alias\":\"completedMatters\",\"moved\":false},{\"x\":0,\"y\":10,\"w\":12,\"h\":10,\"i\":\"8dfd131a-120e-44dd-995c-c54f65a494c6\",\"alias\":\"myCompleted\",\"moved\":false},{\"x\":12,\"y\":10,\"w\":12,\"h\":10,\"i\":\"4aba3afc-6ccc-4fa1-977d-39fa2a07393d\",\"alias\":\"myRequest\",\"moved\":false},{\"x\":12,\"y\":0,\"w\":12,\"h\":10,\"i\":\"ffe00776-ab90-4e1c-a8c9-868d0c6119f2\",\"alias\":\"newProcess\",\"moved\":false},{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"f6825a71-3373-4c51-8322-3787b1766fb2\",\"alias\":\"dashboard\",\"moved\":false}]",
                "designHtml": null,
                "isDef": "N",
                "groupName": null
            },
            {
                "pk": "",
                "name": "的",
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "658684045634306048",
                "memo": "",
                "groupId": "655075364715888640",
                "templateHtml": "\"\"",
                "designHtml": null,
                "isDef": "N",
                "groupName": "抄送组."
            },
            {
                "pk": "",
                "name": "test",
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "657173234654904320",
                "memo": "",
                "groupId": null,
                "templateHtml": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"b6ee27b0-47ba-4e48-b07b-f6941ef41168\",\"alias\":\"userInfo\"}]",
                "designHtml": null,
                "isDef": "N",
                "groupName": null
            },
            {
                "pk": "",
                "name": "布局",
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "657146487108534272",
                "memo": "",
                "groupId": null,
                "templateHtml": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"fade5f28-a089-485b-875a-afa0488a9b58\",\"alias\":\"myFavorites\",\"moved\":false},{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"b350ed3f-fa81-4560-ab7a-4aa7859525f9\",\"alias\":\"userInfo\"}]",
                "designHtml": null,
                "isDef": "N",
                "groupName": null
            }
        ],
        "pageResult": {
            "limit": 5,
            "page": 1,
            "totalCount": 10,
            "totalPages": 2
        }
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< DesktopManagePo >	桌面布局管理实体对象集合

桌面布局管理列表(分页条件查询)数据

简述：

桌面布局管理列表(分页条件查询)数据

请求URL：

http://ip:port/ibps/platform/v3/desktop/manage/queryList
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": [],
        "pageResult": {
            "limit": 5,
            "page": 1,
            "totalCount": 0,
            "totalPages": 0
        }
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< DesktopManagePo >	桌面布局管理实体对象集合

删除

简述：

删除桌面布局管理

请求URL：

http://ip:port/ibps/platform/v3/desktop/manage/remove
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注
desktopManageIds	String[]	是		桌面管理id数组

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/desktop/manage/remove?desktopColumnIds=667781412509712384

返回示例：

{
    "state": 200,
    "request": null,
    "message": "删除桌面布局管理成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

保存

简述：

保存桌面布局管理

请求URL：

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

请求方式：

POST

请求参数：

Headers：

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

Query：

暂无

Body：

名称	类型	是否必须	备注
groupName	string	否	组织名称
id	string	否	主键
name	string	是	布局名称
memo	string	否	布局描述
groupId	string	否	组织ID
templateHtml	string	是	模版内容
designHtml	string	否	设计模版
isDef	string	是	是否是默认

请求参数示例：

{
    "name": "test",
    "memo": "test",
    "templateHtml": "[]",
    "isDef": "N",
    "groupId": "654769529968132096"
}

返回示例：

{
    "state": 200,
    "request": null,
    "message": "保存桌面布局管理成功",
    "cause": "",
    "variables": {
        "id": "667781745696833536"
    },
    "data": null
}

返回参数说明：

名称	类型	备注
data	Void

备注

[1] : APIRequest为动态查询请求对象，详情请移步全局请求格式

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