跳至主要內容

api列表

技术中心大约 3 分钟

api列表

新增大屏

  • 类型:api
  • 地址:/bigScreen/design/add
  • 请求方式:POST
  • 请求参数:
{
	chartList: []           //所有组件
	className: "com.gccloud.dataroom.core.module.manage.dto.DataRoomPageDTO"
	code: ""                // 编码(唯一值)
	icon: "00dataSourceSet" // 图片
	iconColor: "#007aff"    // 图片颜色
	id: ""                  // id
	name: "大屏1"           // 名称
	orderNum: 0             //排序
	pageConfig: {
		w: 1920,            // 宽
		h: 1080,            // 高
        bg: null,           // 常规背景
		bgColor: "#151a26", // 常规背景颜色
		opacity: 100,       // 透明度
		customTheme: "dark",//主题(黑暗/明亮)   
		fitMode: "auto",    //适应模式
        lightBg: null,      // 亮色背景
		lightBgColor: "#f5f7fa",    // 亮色背景颜色
	}
	pageTemplateId: ""          //模板Id
	parentCode: "bigScreenCatalog_KCkaS0vmG3"  //分组
	remark: ""               //备注
	style: ""                //样式
	type: "bigScreen"        //类型
}
  • 返回值
{
    "code":200,//200正常,其他异常
    "msg":null,//错误描述
    "data":"bigScreen_JZc3fqRWEh"
}

编辑大屏

  • 类型:api
  • 地址:/bigScreen/design/update
  • 请求方式:POST
  • 请求参数:
{
	chartList: []           //所有组件
	className: "com.gccloud.dataroom.core.module.manage.dto.DataRoomPageDTO"
	code: "bigScreen_P5j3sIOoay"                // 编码(唯一值)
	icon: "00dataSourceSet" // 图片
	iconColor: "#007aff"    // 图片颜色
	id: "42"                  // id
	name: "大屏1编辑"           // 名称
	orderNum: 0             //排序
	pageConfig: {
		w: 1920,            // 宽
		h: 1080,            // 高
        bg: null,           // 常规背景
		bgColor: "#151a26", // 常规背景颜色
		opacity: 100,       // 透明度
		customTheme: "dark",//主题(黑暗/明亮)   
		fitMode: "auto",    //适应模式
        lightBg: null,      // 亮色背景
		lightBgColor: "#f5f7fa",    // 亮色背景颜色
	}
	pageTemplateId: ""          //模板Id
	parentCode: "bigScreenCatalog_KCkaS0vmG3"  //分组
	remark: ""               //备注
	style: ""                //样式
	type: "bigScreen"        //类型
}
  • 返回参数:
{
	code: 200  //200正常,其他异常
	data: "bigScreen_P5j3sIOoay"
	msg: null //错误描述
}

分页查询大屏

  • 类型:api
  • 地址:/bigScreen/design/page
  • 请求方式:POST
  • 请求参数:
{
    parentCode: '' //分组
    current: 1     //当前页
    size: 10        //每页条数
    searchKey: ''   //搜索关键字
    type: bigScreen //类型
}
  • 返回参数:
{
    "code": 200, //200正常,其他异常
    "msg": null, //错误描述
    "data": {
        "className": "com.gccloud.common.vo.PageVO",
        "totalCount": 4,    //总条数
        "size": 10,         //每页条数
        "totalPage": 1,     //总页数
        "current": 1,       //当前页
        "list": [           //查询的大屏列表
            {
                "id": "44",
                "createDate": null,
                "updateDate": "2024-01-03 14:34:28",
                "createBy": null,
                "updateBy": null,
                "delFlag": 0,
                "name": "大屏2",
                "code": "bigScreen_br9d2rc2ZB",
                "parentCode": "bigScreenCatalog_KCkaS0vmG3",
                "type": null,
                "coverPicture": "",
                "config": null,
                "remark": null,
                "orderNum": 0,
                "appCode": ""
            },
            {
                "id": "42",
                "createDate": null,
                "updateDate": "2024-01-03 14:35:25",
                "createBy": null,
                "updateBy": null,
                "delFlag": 0,
                "name": "大屏1编辑",
                "code": "bigScreen_P5j3sIOoay",
                "parentCode": "bigScreenCatalog_KCkaS0vmG3",
                "type": null,
                "coverPicture": "",
                "config": null,
                "remark": null,
                "orderNum": 0,
                "appCode": ""
            },
            {
                "id": "35",
                "createDate": null,
                "updateDate": "2024-01-03 11:12:28",
                "createBy": null,
                "updateBy": null,
                "delFlag": 0,
                "name": "测试1",
                "code": "bigScreen_paTxEmefEl",
                "parentCode": "",
                "type": null,
                "coverPicture": "",
                "config": null,
                "remark": null,
                "orderNum": 0,
                "appCode": ""
            },
            {
                "id": "32",
                "createDate": null,
                "updateDate": "2024-01-03 11:35:32",
                "createBy": null,
                "updateBy": null,
                "delFlag": 0,
                "name": "测试2",
                "code": "bigScreen_R2xaGqPqvI",
                "parentCode": "",
                "type": null,
                "coverPicture": "/cover/bigScreen_R2xaGqPqvI.png",
                "config": null,
                "remark": null,
                "orderNum": 0,
                "appCode": ""
            }
        ]
    }
}

删除大屏

  • 类型:api
  • 地址:/bigScreen/design/delete/:code
  • 请求方式:POST
  • 响应:
{
	code: 200  //200正常,其他异常
	data: null
	msg: null //错误描述
}

预览大屏

根据大屏默认参数,生成大屏,以预览最终大屏效果

  • 类型:web
  • 地址:/big-screen/preview?code=value
  • 请求参数:
  code="bigScreen_P5j3sIOoay"   // 每个大屏的编码(唯一值)

注:可动态修改参数信息,已达到预览不同大屏的效果

设计大屏

提供对大屏的在线编辑器

  • 类型:web
  • 地址:/big-screen/design?code=value
  • 请求参数:
  code="bigScreen_P5j3sIOoay"   // 每个大屏的编码(唯一值)

注:可动态修改参数信息,已达到设计不同大屏的效果