所有接口调用失败返回结果

字段名称 参数类型 参数说明
code Int 错误码(非200)
message String 失败原因

关于数据权限传递参数详细说明

因为有多个接口使用到数据权限,这里的参数比较复杂,所以在这里单独说明一下,数据权限是根数据连接绑定的,用于控制用户在某个数据连接的某张表下看到的数据信息,数据权限分为行权限和列权限两种。

1. 行权限

字段名称 参数类型 参数说明
dataConnectionId Int 数据链接id
database String(Optional) 数据库名称是否传递是由数据连接的类型决定的,也就是由在编辑数据模型时需不需要选择database决定的
tableName String(Optional) 表名,表名一般情况下必须传,如果不传表名,需要确保该连接下所有表名都有相同的字段
filterType String 筛选器类型, listFilter表示是列表筛选,treeFilter表示的是树状筛选
selectType String 筛选类型,表示是排除选择内容(unselect)还是保留选择内容(select)
filter Object 具体的筛选信息,树状筛选器和列表筛选器的具体信息不一致,看下面的说明
  • dataConnectionId的获取:
    API接口说明 - 图1

  • 内置连接: 数据准备的输出表, 可以在浏览器控制台查看: store.current.config (其他类型的表也可以用这种方法)

    dataConnectionId: 内置连接ID
    database: 线上模式数据准备ID
    tableName: 线上模式输出节点ID

    API接口说明 - 图2

  • filter筛选器的具体内容

//关于一张表下面某个字段的信息
{
    "field": "地区",      //字段名称
    "dataType": "String"  //字段类型("Whole","Decimal","DateTime","String","Date","Time","Boolean"
}
//列表筛选器对应的filter字段内容如下:
{
  "dim": {                  //列表筛选对应的字段
    "field": "地区",
    "dataType": "String"
  },
  "select": [              //列表筛选所选择内容
    "东北",
    "华北"
  ]
}

//树状筛选器对应的filter字段内容如下:
{
  "or": [                  //"or"表示多个条件是或的关系,"and"表示多个条件是与的关系
    {
      "dims": [           //dims表示树状筛选所选择的维度字段成员信息
        {
          "field": "地区",
          "dataType": "String"
        },
        {
          "field": "省/自治区",
          "dataType": "String"
        }
      ],
      "cond": {           //cond表示的是筛选条件
        "inlist": [       //inlist表示是选择,excludelist表示排除
          [
            "东北",
            "黑龙江"
          ],
          [
            "华北",
            "河北"
          ]
        ]
      }
    }
  ]
}

2. 列权限

字段名称 参数类型 参数说明
database String(Optional) 数据库名称是否传递是由数据连接的类型决定的,也就是由在编辑数据模型时需不需要选择database决定的
tableName String(Optional) 表名
tableExprId Number(Optional) 如果限制的字段来自于自定义SQL,需要配置自定义sql的id
tableAlias String(Optional) 自定义sql的场景下,需要传
type String 列权限类型:dataLevel(禁止查看) 或者 presentationLevel(数据脱敏)
dataMasks Array 具体的权限配置,见下方说明
  • dataMasks 筛选器内容
// 对订单表的地区地段设置禁止查看
{
  "tableName": "订单",
  "type": "dataLevel",
  "dataMasks": [{
    "field": "地区",
    "dataType": "String",
    "applyRange": ["view", "export"] //对查看报告和导出的时候设置该列禁止查看
  }]
}