工作区配置

查看工作区列表

GET /openapi/v1/workspaces/

{
 "q": "xxxxxx"
}

参数说明

字段	类型	是否必填	说明
q	string	否	当该字段不传值时，查询全部工作区；该字段传值时，会针对工作区的 name 字段和 desc 字段进行筛选

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": [
  {
   "adapter": 1,
            "desc": "xxx",
            "id": 1,
            "name": "xxxx",
            "hc1": false,
            "auto_add_member": false,
            "date_offset": -1,
            "ddra": true,
            "enable_ddra": true,
            "ddya": true,
            "enable_ddya": true,
            "dt": true,
            "enable_dt": true
  }
 ]
}

参数说明

参数	类型	说明
data.adapter	string	工作区配置的数据库
data.desc	string	工作区描述
data.id	int	工作区 id
data.name	string	工作区名称
data.hc1	bool	是否隐藏数字标题
data.auto_add_member	bool	工作区是否自动添加用户为成员
data.date_offset	int	基础日期偏移值
data.ddra	bool	维度环比分析默认设置
data.enable_ddra	bool	开启维度环比分析
data.ddya	bool	维度同比分析默认设置
data.enable_ddya	bool	开启维度同比分析
data.dt	bool	时间数据智能分析默认设置
data.enable_dt	bool	开启时间数据智能分析

查看工作区信息

GET /openapi/v1/workspaces/{workspaceId}/

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": {
  "adapter": 1,
        "date_offset": -1,
        "ddra": true,
        "ddya": true,
        "desc": "xxxx",
        "dt": true,
        "enable_ddra": true,
        "enable_ddya": true,
        "enable_dt": true,
        "hcl": false,
        "id": 1,
        "name": "xxxxx"
 }
}

参数说明

参数	类型	默认值	说明
data.adapter	int	1	数据库类型
data.date_offset	int	-1	日期偏移量
data.ddra	bool	true	维度环比分析默认设置
data.enable_ddra	bool	true	开启维度环比分析
data.ddya	bool	true	维度同比分析默认设置
data.enable_ddya	bool	true	开启维度同比分析
data.desc	string		工作区描述
data.dt	bool	true	时间数据智能分析默认设置
data.enable_dt	bool	true	开启时间数据智能分析
data.hcl	bool		隐藏数字标题
data.id	int		工作区编号
data.name	string		工作区名称

创建工作区

POST /openapi/v1/workspaces/

请求包体：

{
 "name": "xxxx",
 "desc": "xxxxx",
 "auto_add_member": false,
    "adapter": 1,
    "hc1": false,
    "date_offset": -1,
    "dt": true,
    "enable_dt": true,
    "ddya": true,
    "enable_ddya": true,
    "ddra": true,
    "enable_ddra": true,
    "breakPointDisplayType": 1
}

参数说明

参数	类型	必填项	默认值	说明
name	string	否		工作区名称
desc	string	否		工作区描述
auto_add_member	bool	否		是否自动添加用户为成员
adapter	int	否		工作区连接的数据库类型
hc1	bool	否		是否隐藏数据标题
date_offset	int	否	-1	基础日期偏移值
dt	bool	否	true	时间数据智能分析默认设置
enable_dt	bool	否	true	开启时间数据智能分析
ddya	bool	否	true	维度同比分析默认设置
enable_ddya	bool	否	true	开启维度同比分析
ddra	bool	否	true	维度环比分析默认设置
enable_ddra	bool	否	true	开启维度环比分析
breakPointDisplayType	int	否		日期断点补全类型

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": {
  "adapter": 1,
        "date_offset": -1,
        "ddra": true,
        "ddya": true,
        "desc": "xxxx",
        "dt": true,
        "enable_ddra": true,
        "enable_ddya": true,
        "enable_dt": true,
        "hcl": false,
        "id": 1,
        "name": "xxxxx",
        "breakPointDisplayType": 1
 }
}

参数说明

参数	类型	默认值	说明
data.adapter	int		数据库类型
data.date_offset	int	-1	日期偏移量
data.ddra	bool	true	维度环比分析默认设置
data.enable_ddra	bool	true	开启维度环比分析
data.ddya	bool	true	维度同比分析默认设置
data.enable_ddya	bool	true	开启维度同比分析
data.desc	string		工作区描述
data.dt	bool	true	时间数据智能分析默认设置
data.enable_dt	bool	true	开启时间数据智能分析
data.hcl	bool		隐藏数字标题
data.id	int		工作区编号
data.name	string		工作区名称
data.breakPointDisplayType	int		日期断点补全类型

批量创建工作区

POST /openapi/v1/workspaces/create-workspaces/

请求包体：

{
    "workspaces": [
        {
            "name": "xxxx",
            "desc": "xxxxx",
            "auto_add_member": false,
            "adapter": 1,
            "hc1": false,
            "date_offset": -1,
            "dt": true,
            "enable_dt": true,
            "ddya": true,
            "enable_ddya": true,
            "ddra": true,
            "enable_ddra": true,
            "breakPointDisplayType": 1
        }
    ]
}

参数说明

参数类型与创建工作区参数相同

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": [
        {
        "adapter": 1,
        "date_offset": -1,
        "ddra": true,
        "ddya": true,
        "desc": "xxxx",
        "dt": true,
        "enable_ddra": true,
        "enable_ddya": true,
        "enable_dt": true,
        "hcl": false,
        "id": 1,
        "name": "xxxxx",
        "breakPointDisplayType": 1
        }
    ]
}

编辑工作区

PUT /openapi/v1/workspaces/{workspaceId}/

请求包体：

{
 "adapter": 1,
    "date_offset": -1,
    "ddra": true,
    "ddya": true,
    "desc": "xxxx",
    "dt": true,
    "enable_ddra": true,
    "enable_ddya": true,
    "enable_dt": true,
    "hcl": false,
    "id": 1,
    "name": "xxxxx",
    "breakPointDisplayType": 1
}

参数说明

参数	类型	默认值	说明
adapter	int		数据库类型
date_offset	int	-1	日期偏移量
ddra	bool	true	维度环比分析默认设置
enable_ddra	bool	true	开启维度环比分析
ddya	bool	true	维度同比分析默认设置
enable_ddya	bool	true	开启维度同比分析
desc	string		工作区描述
dt	bool	true	时间数据智能分析默认设置
enable_dt	bool	true	开启时间数据智能分析
hcl	bool		隐藏数字标题
id	int		工作区编号
name	string		工作区名称
breakPointDisplayType	int		日期断点补全类型

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": {
  "adapter": 1,
        "date_offset": -1,
        "ddra": true,
        "ddya": true,
        "desc": "xxxx",
        "dt": true,
        "enable_ddra": true,
        "enable_ddya": true,
        "enable_dt": true,
        "hcl": false,
        "id": 1,
        "name": "xxxxx",
        "breakPointDisplayType": 1
 }
}

参数说明

参数	类型	说明
data.adapter	int	数据库类型
data.date_offset	int	日期偏移量
data.ddra	bool	维度环比分析默认设置
data.enable_ddra	bool	开启维度环比分析
data.ddya	bool	维度同比分析默认设置
data.enable_ddya	bool	开启维度同比分析
data.desc	string	工作区描述
data.dt	bool	时间数据智能分析默认设置
data.enable_dt	bool	开启时间数据智能分析
data.hcl	bool	隐藏数字标题
data.id	int	工作区编号
data.name	string	工作区名称
data.breakPointDisplayType	int	日期断点补全类型

批量编辑工作区

PUT /openapi/v1/workspaces/update-workspaces/

请求包体：

{
 "workspaces": [
  {
         "adapter": 1,
            "date_offset": -1,
            "ddra": true,
            "ddya": true,
            "desc": "xxxx",
            "dt": true,
            "enable_ddra": true,
            "enable_ddya": true,
            "enable_dt": true,
            "hcl": false,
            "id": 1,
            "name": "xxxxx",
            "breakPointDisplayType": 1
  }
 ]
}

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": [
  {
         "adapter": 1,
            "date_offset": -1,
            "ddra": true,
            "ddya": true,
            "desc": "xxxx",
            "dt": true,
            "enable_ddra": true,
            "enable_ddya": true,
            "enable_dt": true,
            "hcl": false,
            "id": 1,
            "name": "xxxxx",
            "breakPointDisplayType": 1
  }
 ]
}

删除工作区

DELETE /openapi/v1/workspaces/{workspaceId}/

批量删除工作区

DELETE /openapi/v1/workspaces/delete-workspaces/

请求包体：

{"workspaceIds": [1, 2]}