报表

更新时间:2020-09-08

创建报表

接口简介

创建报表

接口详情

请求地址

/openapi/v1/group/{groupKey}/report?__scp__={__scp__}

请求类型

POST

请求参数

{
  charts: [],      // 报表内图表设置
  conditions: [],  // 图表内过滤条件
  isDev: false,    // 是否开发模式
  isPublic: false, // 空间内是否公开
  name: "报表创建", // 报表名
  parentHash: '0', // 父目录 hash(可以通过下方[报表树形目录列表]进行获取,下方type === 0 时即为文件夹目录,其中的hash即为当前的parentHash,在根目录创建时parentHash: '0')
  remark: "",      // 简介
  type: 1,         // 报表类型 0文件夹、1报表页面、2iframe页面
  url: ""          // iframe页面地址
}
参数名 类型 必填 描述 默认值 参考值
charts Array 报表内图表设置(不同图表内的具体配置请参考: 图表配置 ) - -
conditions Array 图表内过滤条件(不同过滤组件配置请参考: 过滤组件配置 )) - -
isDev Boolean 是否开发模式 false false
isPublic Boolean 空间内是否公开 false false
name String 报表名 - -
parentHash String 父目录 hash(可以通过下方 [ 报表树形目录列表 ] 进行获取,下方type === 0 时即为文件夹目录,其中的hash即为当前的parentHash,在根目录创建时parentHash: '0') '0' '0'
remark String 简介 - -
type String 报表类型 0 文件夹、1 报表页面、2iframe 页面 1 1
url String iframe 页面地址 - -

返回正确 JSON 示例

{
  data: {
    authType: 0,                        // 公开分享状态 0停止分享、1公开分享、2加密公开分享
    config: {},                         // 报表配置信息
    editable: true,                     // 是否可编辑
    hash: "r_ada15-523rmf5c-xm5bym",    // 报表hash
    hierarchyLevel: 1,                  // 层级level
    icon: "fa fa-th",                   // 图标
    isDev: false,                       // 是否开发模式
    isPublic: false,                    // 是否公开分享
    name: "报表创建",                    // 报表名
    orderIndex: 64,                     // 同级的顺序编号
    password: "",                       // 密码
    remark: "",                         // 备注说明
    source_hash: "",                    // hash ID
    token: "",                          // 分享token
    type: 1,                            // 报表类型,0:文件夹 1:报表 2:iframe
    url: "http://www.baidu.com"         // iframe页面地址
  },
  msg: '',
  status: 0
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499
}

删除报表

接口简介

删除报表

接口详情

请求地址

/openapi/v1/group/{groupKey}/report/{reportHash}?__scp__={__scp__}

请求类型

DELETE

返回正确 JSON 示例

{
  data: {},
  msg: '',
  status: 0
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499
}

获取报表树形目录列表

接口简介

获取报表树形目录列表

接口详情

请求地址

/openapi/v1/group/{groupKey}/report?__scp__={__scp__}

请求类型

GET

请求参数

返回正确 JSON 示例

{
  data: [
    {
      hash: "r_ada15-50z688xs-p284kv",
      source_hash: "",
      type: 1,
      name: "test-report",
      editable: true,
      remark: "测试",
      token: "",
      hierarchyLevel: 1,
      orderIndex: 1,
      isPublic: false,
      isDev: true,
      authType: 0
    },
    {
      hash: "r_ada15-6fni6aob-g2vopk",      // 报表文件夹hash,可作为[创建报表]接口中parentHash字段的值
      source_hash: "",
      type: 0,                              // 类型:0(文件夹)、1(报表)
      name: "报表",
      editable: true,
      remark: "",
      token: "",
      children: [                           // 文件夹中包含的报表
        {
          hash: "r_ada15-5frjkqkz-9kqezk",  // 报表hash
          source_hash: "",
          type: 1,
          name: "时间默认值",
          editable: true,
          remark: "",
          token: "",
          hierarchyLevel: 2,                // 层级深度
          orderIndex: 1,                    // 当前数序(在文件夹中第一个)
          isPublic: false,                  // 是否公开
          isDev: false,
          authType: 0
        }
      ],
      hierarchyLevel: 1,
      orderIndex: 8,
      isPublic: false,
      isDev: false,
      authType: 0
    },
  ],
  msg: '',
  status: 0
}

返回错误 JSON 示例

{
  msg: '错误详情',
  status: 499
}
上一篇数据模型

本页内容