跳转至

视图接口

查询视图

接口地址:/api/v1/view

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
guid guid query true string

响应状态:

状态码 说明 schema
200 OK DatasetDetailsReponse
404 未找到资源

响应参数:

参数名称 参数说明 类型 schema
attributes array详见示例
categories array详见示例
columnResponse array详见示例
type 表类型VIEW: 逻辑视图PARTITION_VIEW:分区视图DIALECT_VIEW: 方言视图INTERNAL_TABLE:内部表 string
parametricView 是否是参数化视图 boolean
params 参数信息 array详见示例 Param
datasetGuid 数据集guid string
description 表的描述信息 string
folderPath array详见示例 Folder
gmtCreate 创建时间 integer(int64) integer(int64)
gmtModified 修改时间 integer(int64) integer(int64)
name 数据集名称 string
originalSql 创建数据集的sql string
owner 负责人 Object详见示例
path 表全路径 array
tags 标签 array TagDTO

响应示例:

{
    "attributes": [
        {
            "assetAttributeId": "",
            "assetPath": "",
            "assetType": "",
            "content": "",
            "displayName": "",
            "type": ""
        }
    ],
    "categories": [
        {
            "categoryId": "",
            "categoryType": "USER/SYS", //如果是SYS，表示未分类
            "frontId": "",
            "name": "",
            "parentId": "",
        }
    ],
    "columnResponse": [
        {
            "attributes": [
                {
                    "assetAttributeId": "",
                    "assetPath": "",
                    "assetType": "",
                    "content": "",
                    "displayName": "",
                    "type": ""
                }
            ],
            "desc": "",
            "isPartitioned": true,
            "name": "",
            "precision": 0,
            "scale": 0,
            "tags": [
                {
                    "tagColor": "",
                    "tagId": "",
                    "tagName": "",
                    "tagType": "COLUMN" // 字段标签
                }
            ],
            "type": "字段类型"
        }
    ],
    "datasetGuid": "",
    "description": "",
    "folderPath": [
        {
            "guid": "",
            "name": ""
        }
    ],
    "gmtCreate": 0, //创建时间
    "gmtModified": 0, //更新时间
    "name": "", //表名称
    "originalSql": "",
    "owner": { //负责人信息
        "userId": "",
        "username": ""
    },
    // VIEW + parametricView=TRUE 表示参数化视图
    "type": "VIEW/DIALECT_VIEW/PARTITION_VIEW/INTERNAL_TABLE",
    "parametricView": true,
    "params": [
        {
            "defaultValue": "", //默认值
            "paramName": "", //参数名称
            "paramType": "" //参数字段类型
        }
    ],
    "path": ["catalog","schema","table"], //表全路径
    "tags": [
        {
            "tagColor": "",
            "tagId": "",
            "tagName": "",
            "tagType": "VIEW" // 视图标签
        }
    ]
}

创建视图

接口地址:/api/v1/view

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述: 如果想创建参数化视图，type选择VIEW, 传params参数。如果想创建方言视图，选择一个数据源名称

请求示例:

{
  "catalogName": "", 
  "datasetGuid": "\"catalog\".\"schema\"",
  "name": "",
  "params": [
    {
      "defaultValue": "",
      "paramName": "",
      "paramType": ""
    }
  ],
  "sql": "",
  "type": "VIEW/DEALECT_VIEW/PARTITION_VIEW"
}

请求体body参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
catalogName 数据源名称，方言视图的时候需要传 false string
datasetGuid schemaGuid"catalog"."schema" true string
name 视图名称 true string
params 参数，参数化视图需要 false array
sql true string
type DIALECT_VIEW:方言视图PARTITION_VIEW:分区视图VIEW: 逻辑视图 true string

响应状态:

状态码 说明 schema
200 OK
404 未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

删除视图

接口地址:/api/v1/view/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "datasetGuid": "\"catalog\".\"schema\".\"view\""
}

请求体boy参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
datasetGuid true string

响应状态:

状态码 说明 schema
200 OK
404 未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

修改视图

接口地址:/api/v1/view/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "catalogName": "",
  "datasetGuid": "",
  "originalSql": "",
  "params": [
    {
      "defaultValue": "",
      "paramName": "",
      "paramType": ""
    }
  ],
  "sql": "",
  "type": "VIEW/PARTITION_VIEW/VIEW"
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
catalogName 数据源名称，方言视图的时候需要传 false string
datasetGuid 视图guid true string
originalSql 修改前SQL true string
params false array 详见示例
sql 修改后SQL true string
type DIALECT_VIEW:方言视图PARTITION_VIEW:分区视图VIEW: 逻辑视图 true string

响应状态:

状态码 说明 schema
200 OK
404 未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}