调用QueryPublicModelEngine,使用FML语句查询数据建模引擎的信息。

  • 每次调用该接口均需使用FML语句请求获取查询信息。
  • 除了数仓分层、业务过程和数据域查询外,其他引擎信息查询均可使用分页查询方式。您可以在FML语句结尾增加offset

    num limit num语句,表示查询信息时的偏移量及每次返回的页数。目前偏移量取值仅支持为页数的倍数。

  • 每次调用该接口时,最多返回1000条数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryPublicModelEngine

系统规定参数。取值:QueryPublicModelEngine

Text String show dim tables

输入查询引擎信息的FML语句,详情请参见使用FML语句配置并管理数据表

当前仅支持show语句。

ProjectId String 1234

DataWorks工作空间的ID。您可以登录DataWorks控制台,进入工作空间管理页面获取ID。

RegionId String cn-beijing

服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

返回数据

名称 类型 示例值 描述
RequestId String 4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4

本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。

ReturnValue Array of Object [{ "gmtModified": 最后修改时间,"code": "表名","creatorId": "创建人ID","creatorName": "创建人名称","modifierId": "修改人ID","gmtCreate": 创建时间,"type": 表类型,"ownerId": "负责人ID","uuid": "系统ID","businessUnitUuid": "业务板块ID","detailType": "表二级类型","ownerName": "负责人名称","name": "表显示名","modifierName": "最后修改人名称","businessProcessUuid": "业务过程ID" }]

返回通过FML语句查询的数据建模引擎信息的结果。

返回结果说明

查询数仓分层使用的FML语句如下。

show layers;

输出参数

参数名

参数类型

示例值

描述信息

code

String

dws

数仓分层编码

englishName

String

dws

数仓分层英文名

name

String

汇总层

数仓分层中文名

ownerId

String

0123456

负责人ID

ownerName

String

甲乙丙丁

负责人名称

description

String

汇总层描述

备注

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询数据域使用的FML语句如下。

show domains;

输出参数

参数名

参数类型

示例值

描述信息

code

String

member

数据域编码

englishName

String

member

数据域英文名

name

String

会员

数据域中文名

ownerId

String

0123456

负责人ID

ownerName

String

甲乙丙丁

负责人名称

businessUnitCode

String

bu-123456

业务板块编码

description

String

会员域备注

备注

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询业务过程使用的FML语句如下。

--无条件列表查询

show business_processes;

--根据code查询业务过程

show business_processes where code='bp-code';

--根据数据域查询业务过程

show business_processes where data_domain='dm-code';

输出参数

参数名

参数类型

示例值

描述信息

code

String

bp-123456

业务过程编码

englishName

String

pay

业务过程英文名

name

String

付款

业务过程中文名

dataDomainCode

String

trade

所属数据域编码

dataDomainName

String

交易

所属数据域中文名

dataDomainUuid

String

dm-123456

所属数据域uuid

ownerId

String

0123456

负责人BaseId

ownerName

String

甲乙丙丁

负责人名称

description

String

付款

备注

source

Integer

2

创建来源(1.系统创建,2.用户创建)

parentCode

String

bp-1234567

父业务过程编码

parentName

String

父购买业务流程

父业务过程名称

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

creatorId

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询业务分类使用的FML语句如下。

show business_categories;

show business_categories where code='code';

show business_categories where keyword='keyword',

show business_categories where uuid='uuid'

输出参数

参数名

参数类型

示例值

描述信息

categoryDetail

DirectoryDetailDTO

业务分类详细信息

业务分类详细信息

name

String

电商

目录名称

detailType

String

DICT

目录子类型

parentUuid

String

dy-123456

父级目录UUID

description

String

描述信息

目录描述

code

String

ind

业务分类code

dataDomains

List

业务分类下挂靠数据域

业务分类下挂靠数据域

code

String

member

数据域编码

englishName

String

member

数据域英文名

name

String

会员

数据域中文名

ownerId

String

0123456

负责人ID

ownerName

String

甲乙丙丁

负责人名称

businessUnitCode

String

bu-123456

业务板块编码

description

String

会员域备注

备注

categoryPath

String

tm.ind

业务分类path

查询数据集市使用的FML语句如下。

show markets;

输出参数

参数名

参数类型

示例值

描述信息

categoryDetail

DirectoryDetailDTO

业务分类详细信息

业务分类详细信息

name

String

电商

目录名称

detailType

String

DICT

目录子类型

parentUuid

String

dy-123456

父级目录UUID

parentDetailType

String

父级目录类型

父级目录类型

parentName

String

父级目录名称

父级目录名称

description

String

描述信息

目录描述

code

String

ind

业务分类code

extendName

String

业务分类扩展名称

业务分类扩展名称

subDetailType

String

common

目录子类型细分类型

auditDTOList

List

[{"baseId":"123","showName":"test"}]

审核人员列表

dataDomains

List

业务分类下挂靠数据域

业务分类下挂靠数据域

code

String

member

数据域编码

englishName

String

member

数据域英文名

name

String

会员

数据域中文名

ownerId

String

0123456

负责人ID

ownerName

String

甲乙丙丁

负责人名称

businessUnitCode

String

bu-123456

业务板块编码

description

String

会员域备注

备注

auditDTOList

List

[{"baseId":"123","showName":"test"}]

审核人员列表

categoryPath

String

tm.ind

业务分类path

查询主题域使用的FML语句如下。

show subjects;

输出参数

参数名

参数类型

示例值

描述信息

categoryDetail

DirectoryDetailDTO

业务分类详细信息

业务分类详细信息

name

String

电商

目录名称

detailType

String

DICT

目录子类型

parentUuid

String

dy-123456

父级目录UUID

parentDetailType

String

父级目录类型

父级目录类型

parentName

String

父级目录名称

父级目录名称

description

String

描述信息

目录描述

code

String

ind

业务分类code

extendName

String

业务分类扩展名称

业务分类扩展名称

subDetailType

String

common

目录子类型细分类型

auditDTOList

List

[{"baseId":"123","showName":"test"}]

审核人员列表

dataDomains

List

业务分类下挂靠数据域

业务分类下挂靠数据域

code

String

member

数据域编码

englishName

String

member

数据域英文名

name

String

会员

数据域中文名

ownerId

String

0123456

负责人ID

ownerName

String

甲乙丙丁

负责人名称

businessUnitCode

String

bu-123456

业务板块编码

description

String

会员域备注

备注

auditDTOList

List

[{"baseId":"123","showName":"test"}]

审核人员列表

categoryPath

String

tm.ind

业务分类path

查询数据标准集使用的FML语句如下。

show dict groups;

输出参数

参数名

参数类型

示例值

描述信息

name

String

电商

目录名称

detailType

String

DICT

目录子类型

parentUuid

String

dy-123456

父级目录UUID

description

String

描述信息

目录描述

code

String

ind

业务分类code

uuid

List

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询数据标准使用的FML语句如下。

show dicts;

输出参数

参数名

参数类型

示例值

描述信息

code

String

列编码

列编码

englishName

String

列英文名称

列英文名称

name

String

列中文名称

列中文名称

no

String

标准编号

标准编号

dataType

String

数据类型

数据类型

length

Integer

列长度

列长度

numericalPrecision

Integer

列精度

列精度

notNull

Boolean

是否不为空

是否不为空

defaultValue

String

默认值

默认值

parentNo

String

父级标准编号

父级标准编号

parentName

String

父级标准名称

父级标准名称

codeTableNo

String

引用码表编号

引用码表编号

codeTableName

String

引用码表名称

引用码表名称

codeTableUuid

String

引用码表UUID

引用码表UUID

directoryUuid

String

所属目录UUID

所属目录UUID

directoryName

String

所属目录名称

所属目录名称

description

String

备注

备注

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询标准代码使用的FML语句如下。

show code tables;

输出参数

参数名

参数类型

示例值

描述信息

code

String

列编码

列编码

name

String

代码名称

代码名称

extendName

String

英文名称

英文名称

description

String

描述

描述

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询度量单位组使用的FML语句如下。

show measure_unit groups;

输出参数

参数名

参数类型

示例值

描述信息

name

String

电商

目录名称

detailType

String

DICT

目录子类型

parentUuid

String

dy-123456

父级目录UUID

description

String

描述信息

目录描述

code

String

ind

业务分类code

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询度量单位使用的FML语句如下。

show measure_units;

输出参数

参数名

参数类型

示例值

描述信息

code

String

列编码

列编码

englishName

String

列英文名称

列英文名称

name

String

列中文名称

列中文名称

directoryUuid

String

单位分组UUID

单位分组UUID

directoryName

String

单位分组名称

单位分组名称

description

String

备注

备注

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询标准代码内容使用的FML语句如下。

show codes from code_table;

输出参数

参数名

参数类型

示例值

描述信息

codeContent

String

code内容值

code内容值

extendNameContent

String

扩展标准代码名称

扩展标准代码名称

nameContent

String

标准代码名称

标准代码名称

description

String

标准代码描述

标准代码描述

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询表信息使用的FML语句如下。

show tables;

输出参数

参数名

参数类型

示例值

描述信息

code

String

dim_shop

表编码

name

String

店铺维度表

表中文名

type

Integer

1

表类型(0:事实表,1:维度表)

detailType

String

normal

表具体类型(普通维度、枚举维度、事务事实)

businessProcessUuid

String

bp-123456

业务过程UUID

businessUnitUuid

String

bu-123456

业务板块UUID

dataWarehouseLayerUuid

String

ly-123456

数仓层UUID

businessCategoryUuid

String

bc-123456

业务分类UUID

ownerId

String

0123456

负责人BaseId

ownerName

String

甲乙丙丁

负责人名称

description

String

店铺表备注

备注

config

String

json字符串

拓展属性配置

lifeCycle

Integer

365

表生命周期

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询维度表使用的FML语句如下。

show dim tables;

输出参数

参数名

参数类型

示例值

描述信息

code

String

dim_shop

表编码

name

String

店铺维度表

表中文名

type

Integer

1

表类型(0:事实表,1:维度表)

detailType

String

normal

表具体类型(普通维度、枚举维度、事务事实

businessProcessUuid

String

bp-123456

业务过程UUID

businessUnitUuid

String

bu-123456

业务板块UUID

dataWarehouseLayerUuid

String

ly-123456

数仓层UUID

businessCategoryUuid

String

bc-123456

业务分类UUID

ownerId

String

0123456

负责人BaseId

ownerName

String

甲乙丙丁

负责人名称

description

String

店铺表备注

备注

config

String

json字符串

拓展属性配置

lifeCycle

Integer

365

表生命周期

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询事实表信息使用的FML语句如下。

show fact tables;

输出参数

参数名

参数类型

示例值

描述信息

code

String

dim_shop

表编码

name

String

店铺维度表

表中文名

type

Integer

1

表类型(0:事实表,1:维度表)

detailType

String

normal

表具体类型(普通维度、枚举维度、事务事实

businessProcessUuid

String

bp-123456

业务过程UUID

businessUnitUuid

String

bu-123456

业务板块UUID

dataWarehouseLayerUuid

String

ly-123456

数仓层UUID

businessCategoryUuid

String

bc-123456

业务分类UUID

ownerId

String

0123456

负责人BaseId

ownerName

String

甲乙丙丁

负责人名称

description

String

店铺表备注

备注

config

String

json字符串

拓展属性配置

lifeCycle

Integer

365

表生命周期

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询汇总表使用的FML语句如下。

show dws tables;

输出参数

参数名

参数类型

示例值

描述信息

dataDomainUuid

String

dm-12345

数据域uuid

dataDomainCode

String

member

数据域Code

dataDomainName

String

会员

数据域名字

timePeriods

List

时间周期列表

时间周期列表

uuid

String

对象唯一标识

对象唯一标识

code

String

英文缩写

英文缩写

name

String

中文名称

中文名称

adjuncts

List

修饰词列表

修饰词列表

uuid

String

uuid

uuid

code

String

code

code

name

String

name

name

dimensions

List

关联维度

关联维度

uuid

String

dm-123456

UUID

bizEntityUuid

String

dim-123456

业务对象uuid

bizEntityCode

String

dim_shop

业务对象英文缩写

bizEntityName

String

店铺表

业务对象中文名称

relUuid

String

dim_a-123456

关联维度uuid

code

String

slr

关联维度英文缩写

name

String

卖家

关联维度中文名称

code

String

dim_shop

表编码

name

String

店铺维度表

表中文名

type

Integer

1

表类型(0:事实表,1:维度表)

detailType

String

normal

表具体类型(普通维度、枚举维度、事务事实)

businessProcessUuid

String

bp-123456

业务过程UUID

businessUnitUuid

String

bu-123456

业务板块UUID

dataWarehouseLayerUuid

String

ly-123456

数仓层UUID

businessCategoryUuid

String

bc-123456

业务分类UUID

ownerId

String

0123456

负责人BaseId

ownerName

String

甲乙丙丁

负责人名称

description

String

店铺表备注

备注

config

String

json字符串

拓展属性配置

lifeCycle

Integer

365

表生命周期

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询表信息同时返回字段信息使用的FML语句如下。

show full tables;

输出参数

参数名

参数类型

示例值

描述信息

tableUuid

String

tb-123456

表UUID

tableCode

String

dim_shop

表编码

tableName

String

店铺表

表名称

columnCode

String

shop_id

列编码

columnName

String

店铺Id

列名称

columnUuid

String

col-123456

列UUID

columnType

String

STRING

列数据类型

columnCategory

String

ATTRIBUTE

列类别

查询列信息使用的FML语句如下。

show columns from table_code;

输出参数

参数名

参数类型

示例值

描述信息

code

String

seller_id

列编码

name

String

卖家Id

列中文名

dataType

String

STRING

数据类型

type

String

ATTRIBUTE

字段类型

isPrimaryKey

Boolean

false

是否主键

isPartitionKey

Boolean

false

是否分区键

partitionOrder

Integer

1

分区键顺序

notNull

Boolean

true

是否非空

dataDictionaryUuid

String

member_id

数据字典编码

dataDictionaryCode

String

会员Id

数据字典名称

codeTableUuid

String

cd-123456

关联码表UUID

codeTableCode

String

sex

关联码表编码

codeTableName

String

性别

关联码表名称

measureUnitCode

String

percent

关联单位编码

measureUnitName

String

关联单位名称

sourceProjectName

String

autotest

来源项目名称

sourceTableCode

String

dict

来源表编码

sourceColumnCode

String

age

来源字段编码

sourceRelationTag

String

label

冗余关系标签

description

String

字段备注

备注

orderId

String

1

字段顺序

columnGroupName

Integer

col_group_1

所属字段组

relationshipList

List

列关系列表

列关系列表

rightTableCode

String

被依赖表编码

被依赖表编码

rightTableType

Integer

右表类型

右表类型

rightColumnCode

String

被依赖列编码

被依赖列编码

config

String

json字符串

拓展属性配置

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询修饰词使用的FML语句如下。

show adjuncts;

输出参数

参数名

参数类型

示例值

描述信息

businessUnitUuid

String

bu-123456

业务板块uuid

businessUnitCode

String

test_bu

业务板块code

businessUnitName

String

测试板块

业务板块name

dataDomainUuid

String

dt-123456

数据域uuid

dataDomainCode

String

member

数据域code

dataDomainName

String

会员域

数据域name

categoryUuid

String

cy-123456

业务分类uuid

categoryCode

String

trade

业务分类code

categoryName

String

电商

业务分类name

type

AdjunctTypeEnum

DIM_VAL

修饰词类型

code

String

beauty

英文缩写

name

String

美妆

中文名称

extendName

String

beauty

英文名称

description

String

美妆描述

描述

bizExpression

String

用于报表统计口径

业务口径

expression

String

beauty = 1

修饰词语义表达式

dimension

DimensionEntityDTO

关联维度定义

关联维度定义

uuid

String

dm-123456

UUID

bizEntityUuid

String

dim-123456

业务对象uuid

bizEntityCode

String

dim_shop

业务对象英文缩写

bizEntityName

String

店铺表

业务对象中文名称

relUuid

String

dim_a-123456

关联维度uuid

code

String

slr

关联维度英文缩写

name

String

卖家

关联维度中文名称

ownerId

String

0123456

负责人BaseId

ownerName

String

甲乙丙丁

负责人名称

isDeleted

DeleteTagEnum

NO

是否被删除

tempUuid

String

临时的唯一标志(适用于批量操作对象的唯一标志)

临时的唯一标志(适用于批量操作对象的唯一标志)

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询时间周期使用的FML语句如下。

show time_periods;

输出参数

参数名

参数类型

示例值

描述信息

businessUnitUuid

String

bu-123456

所属的业务板块uuid

businessUnitCode

String

test_bu

业务板块code

type

TimePeriodTypeEnum

DAY

时间周期类型

typeName

String

时间周期类型名称

code

String

1d

英文缩写

name

String

1天

中文名称

extendName

String

1d

英文名称

description

String

时间周期描述

描述

isDeleted

DeleteTagEnum

NO

是否被删除

timeBegin

String

start_expression

开始时间表达式

timeEnd

String

end_expression

结束时间表达式

gmtCreate

Date

1633885261000

创建时间

gmtModified

Date

1633885261000

修改时间

modifierId

String

0123456

修改人baseId

modifierName

String

甲乙丙丁

修改人显示名称

ownerId

String

0123456

负责人BaseId

ownerName

String

甲乙丙丁

负责人名称

templateType

TimePeriodTemplateEnum

时间周期类型

时间周期类型

beginOffset

Integer

1

开始周期偏移量

endOffset

Integer

1

结束周期偏移量

firstDay

Integer

1

周期第一天(必填场景:type in[WEEK, MONTH, QUARTER, YEAR]),"+ "取值范围:"+ "WEEK(初始星期,周日:1, 周一:2, 周二:3, 周三:4, 周四:5, 周五:6, 周六:7), "+ "MONTH(初始号,月初:1, 月末:99, 2号到27号:[2~27]), "+ "QUARTER(初始月,1月到12月:[0~11]), "+ "YEAR(初始月,1月到12月:[0~11])

tempUuid

String

临时的唯一标志(适用于批量操作对象的唯一标志)

临时的唯一标志(适用于批量操作对象的唯一标志)

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询原子指标使用的FML语句如下。

show atomic indicators;

输出参数

参数名

参数类型

示例值

描述信息

dataDistinct

YesOrNoEnum

YES

数据是否需要去重

aggFunctionType

AggFunctionEnum

SUM

指标聚合函数类型

calExpression

String

price

计算口径(code)

dataType

DataTypeNameEnum

TINYINT

数据类型

dataRound

String

N

数据精度: N,M

dataUnitUuid

String

du-123456

指标单位uuid

dataUnitCode

String

percent

指标单位code

dataUnitName

String

指标单位name

bizExpression

String

业务口径

业务口径

dataRollUpType

DataRollUpEnum

AGG_FUNCTION

数据上卷方式

businessUnitUuid

String

业务板块uuid

业务板块uuid

businessUnitCode

String

业务板块code

业务板块code

businessProcessUuid

String

业务过程uuid

业务过程uuid

businessProcessCode

String

业务过程code

业务过程code

businessProcessName

String

业务过程name

业务过程name

dataDomainUuid

String

数据域uuid

数据域uuid

dataDomainCode

String

数据域code

数据域code

dataDomainName

String

数据域name

数据域name

categoryUuid

String

业务分类uuid

业务分类uuid

categoryCode

String

业务分类code

业务分类code

categoryName

String

业务分类name

业务分类name

type

IndicatorTypeEnum

指标类型

指标类型

code

String

英文缩写

英文缩写

name

String

中文名称

中文名称

extendName

String

英文名称

英文名称

description

String

描述

描述

status

IndicatorStatusEnum

指标状态

指标状态

ownerId

String

负责人BaseId

负责人BaseId

ownerName

String

负责人名称

负责人名称

isDeleted

DeleteTagEnum

NO

是否被删除

tempUuid

String

临时的唯一标志(适用于批量操作对象的唯一标志)

临时的唯一标志(适用于批量操作对象的唯一标志)

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

查询派生指标使用的FML语句如下

show derivative indicators;

输出参数

参数名

参数类型

示例值

描述信息

timePeriodUuid

String

时间周期uuid

时间周期uuid

timePeriodCode

String

时间周期英文缩写

时间周期英文缩写

timePeriodName

String

时间周期中文名称

时间周期中文名称

adjunctUuids

List

修饰词uuid列表

修饰词uuid列表

adjunctCodes

List

修饰词英文缩写列表

修饰词英文缩写列表

adjunctNames

List

修饰词中文名称列表

修饰词中文名称列表

atomicIndicatorUuid

String

原子指标uuid

原子指标uuid

atomicIndicatorCode

String

原子指标英文缩写

原子指标英文缩写

atomicIndicatorName

String

原子指标中文名称

原子指标中文名称

dataType

DataTypeNameEnum

数据类型

数据类型

indicatorDimensionList

List

关联维度列表

关联维度列表

uuid

String

dm-123456

UUID

bizEntityUuid

String

dim-123456

业务对象uuid

bizEntityCode

String

dim_shop

业务对象英文缩写

bizEntityName

String

店铺表

业务对象中文名称

relUuid

String

dim_a-123456

关联维度uuid

code

String

slr

关联维度英文缩写

name

String

卖家

关联维度中文名称

indHash

String

指标hash

指标hash

suggestCode

String

推荐编码

推荐编码

businessUnitUuid

String

业务板块uuid

业务板块uuid

businessUnitCode

String

业务板块code

业务板块code

businessProcessUuid

String

业务过程uuid

业务过程uuid

businessProcessCode

String

业务过程code

业务过程code

businessProcessName

String

业务过程name

业务过程name

dataDomainUuid

String

数据域uuid

数据域uuid

dataDomainCode

String

数据域code

数据域code

dataDomainName

String

数据域name

数据域name

categoryUuid

String

业务分类uuid

业务分类uuid

categoryCode

String

业务分类code

业务分类code

categoryName

String

业务分类name

业务分类name

type

IndicatorTypeEnum

指标类型

指标类型

code

String

英文缩写

英文缩写

name

String

中文名称

中文名称

extendName

String

英文名称

英文名称

description

String

描述

描述

status

IndicatorStatusEnum

指标状态

指标状态

ownerId

String

负责人BaseId

负责人BaseId

ownerName

String

负责人名称

负责人名称

isDeleted

DeleteTagEnum

NO

是否被删除

tempUuid

String

临时的唯一标志(适用于批量操作对象的唯一标志)

临时的唯一标志(适用于批量操作对象的唯一标志)

uuid

String

obj-123456

对象唯一标识

gmtCreate

Date

2022-02-09

2022-02-09

gmtModified

Date

2022-02-10

2022-02-10

creatorId

String

0123456

创建人BaseId

creatorName

String

甲乙丙丁

创建人名称

modifierId

String

0123456

修改人BaseId

modifierName

String

甲乙丙丁

修改人名称

示例

请求示例

http(s)://[Endpoint]/?Action=QueryPublicModelEngine
&Text=show dim tables
&ProjectId=1234
&公共请求参数

请求示例补充说明

javasdk调用的Demo示例如下。  
 QueryPublicModelEngineRequest request = new QueryPublicModelEngineRequest();            
 request.setProjectId(this.projectId);    
 request.setText("show layers;");    
 QueryPublicModelEngineResponse response = client.getAcsResponse(request);    
 //以下仅用于演示如何输出JSON数据,实际使用时请根据需求处理返回数据。   
 ObjectMapper objectMapper = new ObjectMapper();    
 objectMapper.enable(SerializationFeature.INDENT_OUTPUT);    
 objectMapper.setTimeZone(TimeZone.getTimeZone("GMT+8"));    
 String s = objectMapper.writeValueAsString(obj);    
 System.out.println(s);    

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryPublicModelEngineResponse>
    <RequestId>4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4</RequestId>
    <ReturnValue/>
</QueryPublicModelEngineResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4",
  "ReturnValue" : ""
}

返回示例补充说明

 javasdk调用的Demo示例返回结果如下。  
 {
  "requestId" : "x-request-id",  
  "returnValue" : [ {  
    "uuid" : "obj-123456",  
    "gmtCreate" : 1638857552348,  
    "gmtModified" : 1638857552351,  
    "creatorId" : "0123456",  
    "creatorName" : "甲乙丙丁",  
    "modifierId" : "0123456",  
    "modifierName" : "甲乙丙丁",  
    "code" : "dws",  
    "englishName" : "dws",  
    "name" : "汇总层",  
    "ownerId" : "0123456",  
    "ownerName" : "甲乙丙丁",  
    "description" : "汇总层描述"  
  } ]  
}

错误码

HttpCode 错误码 错误信息 描述
400 Valid.FML.NoPermission You are not authorized to access the project resources. 您没有权限访问当前项目资源。
400 Valid.FML.OnlySupportQueryStatement Only FML query statement is supported. 只支持FML查询语句。
400 Valid.FML.ProjectNotExist The project does not exist. 项目信息不存在,请检查输入参数。
400 Valid.FML.StatementNotValid The FML statement is invalid. FML语句不合法,请参考FML语法文档:https://dataworks-doc.yuque.com/docs/share/ff7899ed-c433-4970-b20e-6582ea3939f3?#
400 Valid.FML.ProductExpired 智能数据建模产品购买已到期 智能数据建模产品购买已到期
400 Valid.FML.ProductNotActivated 智能数据建模产品未开通 智能数据建模产品未开通
500 Execute.FML.ProcessError Failed to execute FML statement. FML执行失败,请稍后再试!

访问错误中心查看更多错误码。