观远数据开放平台
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
首页官网社区
文档
  • 帮助中心
  • 观远学堂
首页官网社区
文档
  • 帮助中心
  • 观远学堂
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
  1. 数据集
  • 默认模块
    • 开发指南
      • Token 鉴权
      • 常见问题
    • 用户
      • 批量创建用户
      • 批量删除用户
      • 批量修改用户属性
      • 批量查询用户是否存在
      • 获取用户列表
      • 修改指定用户状态
      • 通过指定的用户的loginid查询对应的uid
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
      • 用户统一登出
      • 通过用户属性值查询用户列表
      • 通过指定用户的loginid登录
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 数据集
      • 使用parquet文件更新数据集
        GET
      • 获取数据集列表
        POST
      • 搜索数据集列表
        POST
      • 查询特定数据集的数据结构
        POST
      • 批量修改数据集更新方式
        POST
      • 获取指定数据集有使用权限的用户列表
        POST
      • 上传数据
        POST
      • 获取数据集下载授权Token
        GET
      • 下载数据集数据
        POST
      • 获取数据集数据
        POST
      • 创建数据集
        POST
      • 更新数据集字段注释
        POST
      • 触发数据集读取数据文件并更新
        GET
      • 通过 TaskID 查询数据集更新结果
        GET
      • 修改数据集schema
        POST
      • 更新数据集
        POST
      • 修改数据集字段别名
        POST
    • 仪表板
      • 获取页面列表
      • 根据页面名称关键词搜索页面
      • 获取指定页面有读权限的用户列表
      • 以树状结构获取页面列表
      • 以PDF或者图片模式导出仪表板
      • 获取仪表板导出文件
    • 订阅预警
      • 下载自定义渠道推送文件
      • 启用/关闭订阅
      • 启用/关闭预警
    • 卡片
      • 获取卡片数据
    • 权限
      • 获取指定用户能访问的页面列表
      • 获取指定用户能访问的数据集列表
      • 修改指定用户与各个页面的访问及归属关系
      • 修改指定用户与各个数据集的访问及归属关系
      • 获取指定用户组能访问的页面列表
      • 获取指定用户组能访问的数据集列表
      • 修改指定用户组与各个页面的访问及归属关系
      • 修改指定用户组与各个数据集的访问及归属关系
      • 通用资源权限授权与解除
    • 资源操作
      • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
      • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
      • 通用资源列表清单
    • 用户登录
      POST
  1. 数据集

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

POST
/public-api/data-source/{dsId}/columns
注意:Body不可为空,至少需要填入两个花括号,否则会报错。

请求参数

Path 参数
dsId
string 
数据集ID
必需
Header 参数
X-Auth-Token
string 
可选
个人token, 从sign in接口获取
Body 参数application/json
object {0}
示例
{}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/public-api/data-source//columns' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功
application/json
Body
result
string 
必需
response
array [object {17}] 
必需
name
string 
必需
fdType
string 
必需
alias
string 
可选
dsId
string 
必需
fdId
string 
必需
metaType
string 
必需
seqNo
integer 
必需
isAggregated
boolean 
必需
calculationType
string 
必需
level
string 
必需
annotation
string 
可选
fdGroupId
string 
可选
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
        }
    ]
}
修改于 2024-12-24 07:52:01
上一页
搜索数据集列表
下一页
批量修改数据集更新方式