platform-bi-web/gitbook/dev/interface-dashboard.md

数据接口 - 看板

获得看板列表

请求路径:

/getListDashboards

请求方式:

HTTP - POST

请求参数

无

请求示例

返回结果

{
    "data": {
        "code": 200,
        "msg": "成功",
        "data": {
            "pageNum": 1,
            "pageSize": 999,
            "size": 1,
            "orderBy": null,
            "startRow": 1,
            "endRow": 1,
            "total": 1,
            "pages": 1,
            "list": [{
                "id": 331,
                "bdName": "样例看板",
                "bdNote": null,
                "bdConfiguration": "[{\"code\":\"709\",\"chartCode\":\"709\",\"name\":\"毛利润组成分析（按物料）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"17\",\"dataSourceName\":\"销售报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"bar\",\"layout\":{\"x\":0,\"y\":0,\"w\":12,\"h\":6,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null},{\"code\":\"712\",\"chartCode\":\"712\",\"name\":\"呆滞库存分析（饼状图）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"14\",\"dataSourceName\":\"库存报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"pie\",\"layout\":{\"x\":0,\"y\":6,\"w\":12,\"h\":15,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null},{\"code\":\"710\",\"chartCode\":\"710\",\"name\":\"呆滞库存分析（单笔记录）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"14\",\"dataSourceName\":\"库存报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"dataView\",\"layout\":{\"x\":0,\"y\":21,\"w\":12,\"h\":6,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null}]",
                "thumbnail": "...",
                "createBy": "祝通鸿",
                "createId": 16,
                "relationColumns": null,
                "createDate": "2018-09-29 17:16:23.0",
                "updateDate": null,
                "reDate": null
            }],
            "firstPage": 1,
            "prePage": 0,
            "nextPage": 0,
            "lastPage": 1,
            "isFirstPage": true,
            "isLastPage": true,
            "hasPreviousPage": false,
            "hasNextPage": false,
            "navigatePages": 8,
            "navigatepageNums": [1]
        }
    }
}

详细说明

---

获得单个看板

请求路径

/getDashboards

请求方式

HTTP - POST

请求参数

看板id

请求示例

331

返回结果

{
    "data": {
        "code": 200,
        "msg": "成功",
        "data": {
            "id": 331,
            "bdName": "样例看板",
            "bdNote": null,
            "bdConfiguration": "[{\"code\":\"709\",\"chartCode\":\"709\",\"name\":\"毛利润组成分析（按物料）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"17\",\"dataSourceName\":\"销售报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"bar\",\"layout\":{\"x\":0,\"y\":0,\"w\":12,\"h\":6,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null},{\"code\":\"712\",\"chartCode\":\"712\",\"name\":\"呆滞库存分析（饼状图）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"14\",\"dataSourceName\":\"库存报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"pie\",\"layout\":{\"x\":0,\"y\":6,\"w\":12,\"h\":15,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null},{\"code\":\"710\",\"chartCode\":\"710\",\"name\":\"呆滞库存分析（单笔记录）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"14\",\"dataSourceName\":\"库存报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"dataView\",\"layout\":{\"x\":0,\"y\":21,\"w\":12,\"h\":6,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null}]",
            "thumbnail": "",
            "createBy": "祝通鸿",
            "createId": 16,
            "relationColumns": "[]",
            "createDate": "2018-09-29 17:16:23.0",
            "updateDate": null,
            "reDate": null
        }
    }
}

详细说明

---

新增看板

请求路径

/inputDashboards

请求方式

HTTP - POST

请求参数

字段名	类型	说明
bdName	String	看板标题
bdConfiguration	String	看板内容
thumbnail	String	缩略图
relationColumns	String	关联列设置

请求示例

{
    "bdName": "无标题",
    "bdNote": "",
    "bdConfiguration": "[]",
    "thumbnail": "",
    "relationColumns": "[]"
}

返回结果

详细说明

---

删除看板

请求路径

/delDashboards

请求方式

HTTP - POST

请求参数

[看板id]

返回结果

{
    "data": {
        "code": 200,
        "msg": "成功",
        "data": null
    }
}

详细说明

---

更新看板

请求路径

/updateDashboards

请求方式

HTTP - POST

请求参数

字段名	类型	说明
id	Number	看板id
bdName	String	看板标题
bdConfiguration	String	看板内容
thumbnail	String	缩略图
relationColumns	String	关联列设置

请求示例

返回结果

详细说明

---

看板分发

请求路径

/addObject

请求方式

HTTP - POST

请求参数

字段名	类型	说明

请求示例

返回结果

详细说明

---

看板移交

• 参照数据源分组接口说明

  请求路径

  /changeDashOrder

  请求方式

  HTTP - POST

  请求参数

  字段名	类型	说明

  请求示例

  返回结果

  详细说明

  ---