观远数据开放平台
返回最新版
当前版本V7.1.0
观远数据开放平台
  • 开发指南
  • 数据集
    • 使用parquet文件更新数据集GET
    • 获取数据集列表POST
    • 修改数据集路径POST
    • 数据集删除POST
    • 搜索数据集列表POST
    • 查询特定数据集的数据结构POST
    • 批量修改数据集更新方式POST
    • 获取指定数据集有使用权限的用户列表POST
    • 上传数据集POST
    • 获取数据集下载授权TokenGET
    • 下载数据集数据POST
    • 获取数据集数据POST
    • 创建数据集POST
    • 更新数据集字段注释POST
    • 触发数据集读取数据文件并更新GET
    • 通过 TaskID 查询数据集更新结果GET
    • 修改数据集schemaPOST
    • 更新数据集POST
    • 修改数据集字段别名POST
    • 修改数据集名称POST
    • 数据集预览接口POST
    • 提供修改SQL模型结构接口POST
    • 获取数据集目录列表的接口,支持指定目录搜索POST
    • 批量查询数据集基本信息POST
    • 批量查询数据集权限信息POST
  • 仪表板
  • 订阅预警
  • 卡片
  • 权限
  • 资源操作
  • 卡片导出
  • session
  • 文件夹
  • 数据账户
  • 身份认证
  • 用户管理
亮色模式

    查询特定数据集的数据结构

    POST/public-api/data-source/{dsId}/columns

    :::note[接口简介]
    通过指定数据集,查询数据结构
    注意:Body不可为空,至少需要填入两个花括号,否则会报错。
    :::

    请求参数

    Path 参数
    dsId
    string 
    数据集ID
    必需
    Header 参数
    X-Auth-Token
    string 
    可选

    个人token, 从sign in接口获取

    Body 参数application/json
    object {0}
    示例
    {}

    示例代码

    返回响应

    成功(200)
    HTTP 状态码: 200
    内容格式: JSONapplication/json
    数据结构
    result
    string 
    请求状态
    必需

    枚举值: ok、fail

    response
    array [object {17}] 
    响应结果
    必需
    name
    string 
    字段名
    必需
    fdType
    string 
    字段类型
    必需
    alias
    string 
    别名
    可选
    dsId
    string 
    数据集ID
    必需
    fdId
    string 
    字段ID
    必需
    metaType
    string 
    元数据类型
    必需
    seqNo
    integer 
    序号
    必需
    isAggregated
    boolean 
    是否聚合
    必需
    calculationType
    string 
    计算类型
    必需
    level
    string 
    类型
    必需
    annotation
    string 
    字段注释
    可选
    fdGroupId
    string 
    字段组ID
    可选
    isDetectionSensitive
    boolean 
    是否探测敏感字段
    可选
    isSensitive
    boolean 
    是否敏感字段
    可选
    formula
    string 
    表达式
    可选
    baseFdType
    string 
    新建字段真实类型
    可选
    consolidation
    string  | integer  | boolean  | array  | object  | number  | null 
    分组字段
    可选
    示例
    {
      "result": "ok",
      "response": [
        {
          "name": "id",
          "fdType": "INT",
          "alias": "id333",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "g69d58bb0b3ab4c84bdbf673",
          "metaType": "METRIC",
          "seqNo": 0,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "annotation": "",
          "fdGroupId": "vzYeMhldSzsAysEwrDoxqyVo",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "createDate",
          "fdType": "DATE",
          "alias": "createDate",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "vbfb3ba3fb6104cb193697c5",
          "metaType": "DIM",
          "seqNo": 1,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "annotation": "",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "brand",
          "fdType": "STRING",
          "alias": "brand",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "xa8859a59d4494db9b418cef",
          "metaType": "DIM",
          "seqNo": 2,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "annotation": "",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "shopCode",
          "fdType": "STRING",
          "alias": "shopCode",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "ke509e369f1404e2dacbd56a",
          "metaType": "DIM",
          "seqNo": 3,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "annotation": "",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "brand_category",
          "fdType": "STRING",
          "alias": "brand_category",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "ne887566a58584ebeba7576c",
          "metaType": "DIM",
          "seqNo": 4,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "month_category",
          "fdType": "STRING",
          "alias": "month_category",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "we7028997ede34b00b5d1303",
          "metaType": "DIM",
          "seqNo": 5,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "region_category",
          "fdType": "STRING",
          "alias": "region_category",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "i4266c28d52e54afba997efb",
          "metaType": "DIM",
          "seqNo": 6,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "shopCode_length",
          "fdType": "LONG",
          "alias": "shopCode_length",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "kb6c8f9c6e0d44ea49af324d",
          "metaType": "METRIC",
          "seqNo": 7,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "brand_shop_code_concat",
          "fdType": "STRING",
          "alias": "brand_shop_code_concat",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "r782e198b23af4f4dac8e24b",
          "metaType": "DIM",
          "seqNo": 8,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "shopCode_prefix",
          "fdType": "STRING",
          "alias": "shopCode_prefix",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "lf0035656b4394d4a8fba5a9",
          "metaType": "DIM",
          "seqNo": 9,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "brand_prefix",
          "fdType": "STRING",
          "alias": "brand_prefix",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "jdbecf1cacb384df7b194267",
          "metaType": "DIM",
          "seqNo": 10,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "id_parity",
          "fdType": "STRING",
          "alias": "id_parity",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "ofc93ac9d88b64a82b6d787d",
          "metaType": "DIM",
          "seqNo": 11,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "id_category",
          "fdType": "STRING",
          "alias": "id_category",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "v8c90a7c1aaac4f3e85f8fc7",
          "metaType": "DIM",
          "seqNo": 12,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "brand_length_half",
          "fdType": "DOUBLE",
          "alias": "brand_length_half",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "bc816990e4e664a0c8f9e637",
          "metaType": "METRIC",
          "seqNo": 13,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "shopCode_start_category",
          "fdType": "STRING",
          "alias": "shopCode_start_category",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "u84b4d66985d0480190eaf01",
          "metaType": "DIM",
          "seqNo": 14,
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        },
        {
          "name": "createDate ",
          "fdType": "DOUBLE",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "g56713a142ccd4888bd1aadc",
          "metaType": "METRIC",
          "seqNo": 15,
          "formula": "[scoreUsed]+[amount]",
          "isAggregated": false,
          "calculationType": "normal",
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false,
          "baseFdType": "DOUBLE"
        },
        {
          "name": "分组",
          "fdType": "STRING",
          "dsId": "i3006c6d1e2ca46daaef0a10",
          "fdId": "w8f0293b0c23d4606a2f4b87",
          "metaType": "DIM",
          "seqNo": 17,
          "formula": "{\"consolidation\":{\"sourceFdId\":\"xa8859a59d4494db9b418cef\",\"sourceName\":\"brand\",\"displayAllOthers\":\"group\",\"sourceFdType\":\"STRING\",\"groupType\":\"ITEM\",\"groups\":[{\"groupName\":\"ivp\",\"selectedValues\":[\"Fake\"]},{\"groupName\":\"其他\",\"selectedValues\":[],\"isOtherGroup\":true}]}}",
          "isAggregated": false,
          "calculationType": "normal",
          "consolidation": {
            "sourceFdId": "xa8859a59d4494db9b418cef",
            "sourceName": "brand",
            "displayAllOthers": "group",
            "sourceFdType": "STRING",
            "groupType": "ITEM",
            "groups": [
              {
                "groupName": "ivp",
                "selectedValues": [
                  "Fake"
                ]
              },
              {
                "groupName": "其他",
                "selectedValues": [],
                "isOtherGroup": true
              }
            ]
          },
          "level": "dataset",
          "isDetectionSensitive": false,
          "isSensitive": false
        }
      ]
    }
    最后修改时间: 3 个月前
    上一页
    POST搜索数据集列表
    下一页
    POST批量修改数据集更新方式
    举报