我的桌面布局管理 - Powered by MinDoc

删除我的桌面布局
查询我的桌面布局信息
我的桌面布局信息
我的桌面布局信息【个人桌面布局】
我的桌面布局列表(分页条件查询)数据
删除(批量)
保存我的桌面布局
备注

删除我的桌面布局

简述：

删除我的桌面布局

请求URL：

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

请求方式：

POST

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
desktopMyLayoutId	String	是		我的桌面布局id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/desktop/my/layout/deleteLayout?desktopMyLayoutId=656460872893333504

返回示例：

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

返回参数说明：

名称	类型	备注
data	Void

查询我的桌面布局信息

简述：

查询我的桌面布局信息

请求URL：

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

请求方式：

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
desktopMyLayoutId	String	是		我的桌面布局id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/desktop/my/layout/get?desktopMyLayoutId=654622878347558912

返回示例：

{
    "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": "654622878347558912",
        "userId": "654622686055497728",
        "sysAlias": "ibps",
        "templateHtml": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"b14b246d-e9bf-4612-8314-c741c4f466f9\",\"alias\":\"userInfo\",\"moved\":false},{\"x\":12,\"y\":0,\"w\":12,\"h\":10,\"i\":\"bf77ca14-3f4d-4a99-8c24-863c1c25e042\",\"alias\":\"pendingMatters\",\"moved\":false}]",
        "designHtml": "ibps",
        "layoutId": null
    }
}

返回参数说明：

名称	类型	备注
data	DesktopMyLayoutPo	我的桌面布局对象信息

TODO

GET
/desktop/my/layout/getLayout
获取我的桌面布局信息

我的桌面布局信息

简述：

根据当前用户，子系统返回我的桌面布局信息

请求URL：

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

请求方式：

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
systemAlias	String	是		子系统别名

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/desktop/my/layout/getMyDesktop?systemAlias=ibps

返回示例：

{
    "state": 200,
    "request": null,
    "message": "获取我的桌面布局成功",
    "cause": "",
    "variables": {},
    "data": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"47173073-92f0-44e8-901e-0ba0b4e5823f\",\"alias\":\"line\"}]"
}

返回参数说明：

名称	类型	备注
data	String

我的桌面布局信息【个人桌面布局】

简述：

根据当前用户，子系统返回我的桌面布局信息

请求URL：

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

请求方式：

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
systemAlias	String	是		子系统别名

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/desktop/my/layout/getMyLayout?systemAlias=ibps

返回示例：

{
    "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": "656513884521234432",
        "userId": "654384477392338944",
        "sysAlias": "ibps",
        "templateHtml": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"e299daf7-7375-434d-9822-9a6c3028f845\",\"alias\":\"userInfo\"}]",
        "designHtml": "ibps",
        "layoutId": null
    }
}

返回参数说明：

名称	类型	备注
data	DesktopMyLayoutPo	我的桌面布局对象信息

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

简述：

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

请求URL：

http://ip:port/ibps/platform/v3/desktop/my/layout/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": "656513884521234432",
                "userId": "654384477392338944",
                "sysAlias": "ibps",
                "templateHtml": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"e299daf7-7375-434d-9822-9a6c3028f845\",\"alias\":\"userInfo\"}]",
                "designHtml": "ibps",
                "layoutId": null
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "655005837621723136",
                "userId": "654991377871929344",
                "sysAlias": "ibps",
                "templateHtml": "[{\"x\":12,\"y\":0,\"w\":12,\"h\":10,\"i\":\"26e343b9-ade0-4baf-b95f-50a07ffec22b\",\"alias\":\"userInfo\",\"moved\":false},{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"72ab230c-928a-410a-9bab-d053913ee3e0\",\"alias\":\"unreadMessage\",\"moved\":false}]",
                "designHtml": "ibps",
                "layoutId": null
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "654622878347558912",
                "userId": "654622686055497728",
                "sysAlias": "ibps",
                "templateHtml": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"b14b246d-e9bf-4612-8314-c741c4f466f9\",\"alias\":\"userInfo\",\"moved\":false},{\"x\":12,\"y\":0,\"w\":12,\"h\":10,\"i\":\"bf77ca14-3f4d-4a99-8c24-863c1c25e042\",\"alias\":\"pendingMatters\",\"moved\":false}]",
                "designHtml": "ibps",
                "layoutId": null
            }
        ],
        "pageResult": {
            "limit": 20,
            "page": 1,
            "totalCount": 3,
            "totalPages": 1
        }
    }
}

返回参数说明：

名称	类型	备注
data	APIPageList< DesktopMyLayoutPo >	我的桌面布局对象信息

删除(批量)

简述：

删除我的桌面布局

请求URL：

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

请求方式：

POST

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
desktopMyLayoutIds	String[]	是		我的桌面布局ids

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/platform/v3/desktop/my/layout/remove?desktopMyLayoutIds=656513884521234432

返回示例：

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

返回参数说明：

名称	类型	备注
data	Void

保存我的桌面布局

简述：

保存我的桌面布局

请求URL：

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

请求方式：

POST

请求参数：

Headers：

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

Query：

暂无

Body：

名称	类型	是否必须	备注
userId	string	否	用户ID
sysAlias	string	是	系统别名
id	string	否	主键
templateHtml	string	是	模版内容
designHtml	string	是	设计模版
layoutId	string	否	布局管理ID

请求参数示例：

{
    "id": "",
    "sysAlias": "ibps",
    "templateHtml": "[{\"x\":0,\"y\":0,\"w\":12,\"h\":10,\"i\":\"a0bd0657-368e-48bc-a1ca-2663cb783b35\",\"alias\":\"userInfo\"}]",
    "designHtml": "ibps"
}

返回示例：

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

返回参数说明：

名称	类型	备注
data	Void

TODO

POST
/desktop/my/layout/saveLayout
保存首页布局

备注

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

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