QueryPublicModelEngine による FML 文での Data Modeling オブジェクトのクエリ - DataWorks

操作説明

本 API オペレーションを呼び出すたびに、FML ステートメントを用いて Data Modeling で作成されたオブジェクトの情報を照会する必要があります。
データ層、ビジネスプロセス、およびデータドメインを除くすべてのオブジェクトについては、ページ単位での情報照会が可能です。FML ステートメントの末尾にオフセットを追加できます。「num LIMIT num」ステートメントは、オブジェクト情報の照会時に適用されるオフセットと、1 回の応答で返されるページ数を指定します。オフセット値は、ページ数の倍数である必要があります。
本 API オペレーションを 1 回呼び出すと、最大 1,000 件のエントリが返されます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Text	string	必須	Data Modeling で作成されたオブジェクトの情報を照会するための FML ステートメントです。詳細については、「FML ステートメントを用いたデータテーブルの設定および管理」をご参照ください。SHOW ステートメントのみがサポートされています。	show dim tables
ProjectId	string	必須	DataWorks ワークスペース ID です。DataWorks コンソール（https://workbench.data.aliyun.com/console）にログインし、「ワークスペース」ページに移動して、ID を確認できます。	1234

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエスト ID です。	4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4
ReturnValue	array<object>	照会されたオブジェクトの情報です。
	object	照会されたオブジェクトの情報です。

レスポンスの説明

データ層を照会するための FML ステートメント

show layers;
レスポンスパラメーター

パラメーター	型	例	説明
code	String	dws	データ層のコードです。
englishName	String	dws	データ層の名前です。
name	String	DWS layer	データ層の表示名です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
description	String	Description of the DWS layer	データ層の説明です。
uuid	String	obj-123456	データ層の UUID です。
gmtCreate	TimeStamp	1644397025000	データ層が作成された時刻です。
gmtModified	TimeStamp	1644459965000	データ層が最後に変更された時刻です。
creatorId	String	0123456	データ層を作成したユーザーの ID です。
creatorName	String	A、B、C、および D	データ層を作成したユーザーの名前です。
modifierId	String	0123456	データ層を最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	データ層を最後に変更したユーザーの名前です。

データドメインを照会するための FML ステートメント

show domains;
レスポンスパラメーター

パラメーター	型	例	説明
code	String	member	データドメインのコードです。
englishName	String	member	データドメインの名前です。
name	String	Member	データドメインの表示名です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
businessUnitCode	String	bu-123456	業務部門のコードです。
description	String	Description of the Member data domain	データドメインの説明です。
uuid	String	obj-123456	データドメインの UUID です。
gmtCreate	TimeStamp	1644397025000	データドメインが作成された時刻です。
gmtModified	TimeStamp	1644459965000	データドメインが最後に変更された時刻です。
creatorId	String	0123456	データドメインを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	データドメインを作成したユーザーの名前です。
modifierId	String	0123456	データドメインを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	データドメインを最後に変更したユーザーの名前です。

ビジネスプロセスを照会するための FML ステートメント

検索条件を設定せずにビジネスプロセスを照会する FML ステートメント：show business_processes;
ビジネスプロセスのコードに基づいてビジネスプロセスを照会する FML ステートメント：show business_processes where code='bp-code';
データドメインのコードに基づいてビジネスプロセスを照会する FML ステートメント：show business_processes where data_domain='dm-code';

レスポンスパラメーター

パラメーター	型	例	説明
code	String	bp-123456	ビジネスプロセスのコードです。
englishName	String	pay	ビジネスプロセスの名前です。
name	String	Payment	ビジネスプロセスの表示名です。
dataDomainCode	String	trade	ビジネスプロセスが属するデータドメインのコードです。
dataDomainName	String	Transaction	ビジネスプロセスが属するデータドメインの表示名です。
dataDomainUuid	String	dm-123456	ビジネスプロセスが属するデータドメインの UUID です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
description	String	Payment	ビジネスプロセスの説明です。
source	Integer	2	ビジネスプロセスのソースです。有効な値は以下のとおりです。1：システムによって作成されたビジネスプロセスを示します。2：ユーザーによって作成されたビジネスプロセスを示します。
uuid	String	obj-123456	ビジネスプロセスの UUID です。
gmtCreate	TimeStamp	1644397025000	ビジネスプロセスが作成された時刻です。
gmtModified	TimeStamp	1644459965000	ビジネスプロセスが最後に変更された時刻です。
creatorId	String	creatorId	ビジネスプロセスを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	ビジネスプロセスを作成したユーザーの名前です。
modifierId	String	0123456	ビジネスプロセスを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	ビジネスプロセスを最後に変更したユーザーの名前です。

ビジネスカテゴリを照会するための FML ステートメント

 show business_categories;
 show business_categories where code='code';
 show business_categories where keyword='keyword';
 show business_categories where uuid='uuid';

レスポンスパラメーター

パラメーター	型	例	説明
categoryDetail	DirectoryDetailDTO	{"uuid": "cate_uuid", "code": "trd", "name": "Transaction"}	ビジネスカテゴリの詳細です。
name	String	E-commerce	ディレクトリの名前です。
detailType	String	DICT	ディレクトリのタイプです。
parentUuid	String	dy-123456	親ディレクトリの UUID です。
description	String	Description	ディレクトリの説明です。
code	String	ind	ビジネスカテゴリのコードです。
dataDomains	List	[{"uuid": "domain1", "code": "trd", "name": "Transaction data domain"}]	ビジネスカテゴリに関連付けられたデータドメインです。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
businessUnitCode	String	bu-123456	業務部門のコードです。
description	String	Description	ディレクトリの説明です。
categoryPath	String	tm.ind	ビジネスカテゴリのパスです。

データマートを照会するための FML ステートメント

show markets; レスポンスパラメーター

パラメーター	型	例	説明
categoryDetail	DirectoryDetailDTO	{"uuid": "cate_uuid", "code": "trd", "name": "Transaction"}	データマートの詳細です。
name	String	E-commerce	ディレクトリの名前です。
detailType	String	DICT	ディレクトリのタイプです。
parentUuid	String	dy-123456	親ディレクトリの UUID です。
description	String	Description	ディレクトリの説明です。
code	String	ind	ビジネスカテゴリのコードです。
subDetailType	String	common	ディレクトリのサブタイプです。
auditDTOList	List	[{"baseId":"123","showName":"test"}]	レビュアーです。
code	String	member	データドメインのコードです。
englishName	String	member	データドメインの名前です。
name	String	Member	データドメインの表示名です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
businessUnitCode	String	bu-123456	業務部門のコードです。
description	String	Description of the Member data domain	データドメインの説明です。
auditDTOList	List	[{"baseId":"123","showName":"test"}]	レビュアーです。
categoryPath	String	tm.ind	ビジネスカテゴリのパスです。

主題領域を照会するための FML ステートメント

show subjects; レスポンスパラメーター

パラメーター	型	例	説明
categoryDetail	DirectoryDetailDTO	{"uuid": "cate_uuid", "code": "trd", "name": "Transaction"}	主題領域の詳細です。
name	String	E-commerce	ディレクトリの名前です。
detailType	String	DICT	ディレクトリのタイプです。
parentUuid	String	dy-123456	親ディレクトリの UUID です。
description	String	Description	ディレクトリの説明です。
code	String	ind	ビジネスカテゴリのコードです。
subDetailType	String	common	ディレクトリのサブタイプです。
auditDTOList	List	[{"baseId":"123","showName":"test"}]	レビュアーです。
code	String	member	データドメインのコードです。
englishName	String	member	データドメインの名前です。
name	String	Member	データドメインの表示名です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
businessUnitCode	String	bu-123456	業務部門のコードです。
description	String	Description of the Member data domain	主題領域の説明です。
auditDTOList	List	[{"baseId":"123","showName":"test"}]	レビュアーです。
categoryPath	String	tm.ind	ビジネスカテゴリのパスです。

データ標準セットを照会するための FML ステートメント

show dict groups; レスポンスパラメーター

パラメーター	型	例	説明
name	String	E-commerce	ディレクトリの名前です。
detailType	String	DICT	ディレクトリのタイプです。
parentUuid	String	dy-123456	親ディレクトリの UUID です。
description	String	Description	ディレクトリの説明です。
code	String	ind	ビジネスカテゴリのコードです。
uuid	List	obj-123456	データ標準セットの UUID です。
gmtCreate	TimeStamp	1644397025000	データ標準セットが作成された時刻です。
gmtModified	TimeStamp	1644459965000	データ標準セットが最後に変更された時刻です。
creatorId	String	0123456	データ標準セットを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	データ標準セットを作成したユーザーの名前です。
modifierId	String	0123456	データ標準セットを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	データ標準セットを最後に変更したユーザーの名前です。

データ標準を照会するための FML ステートメント

show dicts; レスポンスパラメーター

パラメーター	型	例	説明
code	String	shop_type	データ標準の名前の略称です。
englishName	String	shop type	データ標準の名前です。
name	String	Shop type	データ標準の表示名です。
no	String	SN00001	データ標準 ID です。
dataType	String	STRING	データ標準を使用するフィールドのデータの型です。
length	Integer	10	データ標準を使用するフィールドの値の最大桁数です。
numericalPrecision	Integer	2	データ標準を使用するフィールドの値に保持される小数点以下の桁数です。
notNull	Boolean	false	データ標準を使用するフィールドの値が NULL 以外であるかどうかを示します。
defaultValue	String	Flagship shop	デフォルト値です。
parentNo	String	SN0001	親データ標準の ID です。
parentName	String	Shop	親データ標準の名前です。
codeTableNo	String	shop_type	データ標準を使用するフィールドの値の範囲を定義するルックアップテーブルのコードです。
codeTableName	String	Shop type	データ標準を使用するフィールドの値の範囲を定義するルックアップテーブルの名前です。
codeTableUuid	String	tb-0001	データ標準を使用するフィールドの値の範囲を定義するルックアップテーブルの UUID です。
directoryUuid	String	Directory UUID	データ標準が格納されているディレクトリの UUID です。
directoryName	String	Shop directory	データ標準が格納されているディレクトリの名前です。
description	String	remark	データ標準の説明です。
uuid	String	obj-123456	データ標準の UUID です。
gmtCreate	TimeStamp	1644397025000	データ標準が作成された時刻です。
gmtModified	TimeStamp	1644459965000	データ標準が最後に変更された時刻です。
creatorId	String	0123456	データ標準を作成したユーザーの ID です。
creatorName	String	A、B、C、および D	データ標準を作成したユーザーの名前です。
modifierId	String	0123456	データ標準を最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	データ標準を最後に変更したユーザーの名前です。

ルックアップテーブルを照会するための FML ステートメント

show code tables; レスポンスパラメーター

パラメーター	型	例	説明
code	String	shop_type	ルックアップテーブルのコードです。
name	String	Shop type	ルックアップテーブルの表示名です。
extendName	String	shop type	ルックアップテーブルの名前です。
description	String	remark	ルックアップテーブルの説明です。
uuid	String	obj-123456	ルックアップテーブルの UUID です。
gmtCreate	TimeStamp	1644397025000	ルックアップテーブルが作成された時刻です。
gmtModified	TimeStamp	1644459965000	ルックアップテーブルが最後に変更された時刻です。
creatorId	String	0123456	ルックアップテーブルを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	ルックアップテーブルを作成したユーザーの名前です。
modifierId	String	0123456	ルックアップテーブルを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	ルックアップテーブルを最後に変更したユーザーの名前です。

測定単位グループを照会するための FML ステートメント

show measure_unit groups; レスポンスパラメーター

パラメーター	型	例	説明
name	String	E-commerce	ディレクトリの名前です。
detailType	String	DICT	ディレクトリのタイプです。
parentUuid	String	dy-123456	親ディレクトリの UUID です。
description	String	Description	ディレクトリの説明です。
code	String	ind	ビジネスカテゴリのコードです。
uuid	String	obj-123456	測定単位グループの UUID です。
gmtCreate	TimeStamp	1644397025000	測定単位グループが作成された時刻です。
gmtModified	TimeStamp	1644459965000	測定単位グループが最後に変更された時刻です。
creatorId	String	0123456	測定単位グループを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	測定単位グループを作成したユーザーの名前です。
modifierId	String	0123456	測定単位グループを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	測定単位グループを最後に変更したユーザーの名前です。

測定単位を照会するための FML ステートメント

show measure_units; レスポンスパラメーター

パラメーター	型	例	説明
code	String	yuan	測定単位の名前の略称です。
englishName	String	RMB	測定単位の名前です。
name	String	Yuan	測定単位の表示名です。
directoryUuid	String	di-0001	測定単位が属する測定単位グループの UUID です。
directoryName	String	Currency	測定単位が属する測定単位グループの名前です。
description	String	remark	測定単位の説明です。
uuid	String	obj-123456	測定単位の UUID です。
gmtCreate	TimeStamp	1644397025000	測定単位が作成された時刻です。
gmtModified	TimeStamp	1644459965000	測定単位が最後に変更された時刻です。
creatorId	String	0123456	測定単位を作成したユーザーの ID です。
creatorName	String	A、B、C、および D	測定単位を作成したユーザーの名前です。
modifierId	String	0123456	測定単位を最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	測定単位を最後に変更したユーザーの名前です。

ルックアップテーブルのデータを照会するための FML ステートメント

show codes from code_table; レスポンスパラメーター

パラメーター	型	例	説明
codeContent	String	0	ルックアップテーブルの内容です。
extendNameContent	String	female	ルックアップテーブルの表示名です。
nameContent	String	Female	ルックアップテーブルの名前です。
description	String	remark	ルックアップテーブルの説明です。
uuid	String	obj-123456	ルックアップテーブルの UUID です。
gmtCreate	TimeStamp	1644397025000	ルックアップテーブルが作成された時刻です。
gmtModified	TimeStamp	1644459965000	ルックアップテーブルが最後に変更された時刻です。
creatorId	String	0123456	ルックアップテーブルを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	ルックアップテーブルを作成したユーザーの名前です。
modifierId	String	0123456	ルックアップテーブルを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	ルックアップテーブルを最後に変更したユーザーの名前です。

命名辞書を照会するための FML ステートメント

show naming dicts; レスポンスパラメーター

パラメーター	型	例	説明
code	String	shop	命名辞書の名前の略称です。
creatorId	String	0123456	命名辞書を作成したユーザーの ID です。
creatorName	String	A、B、C、および D	命名辞書を作成したユーザーの名前です。
extendName	String	shop	命名辞書の名前です。
gmtCreate	TimeStamp	1644397025000	命名辞書が作成された時刻です。
gmtModified	TimeStamp	1644459965000	命名辞書が最後に変更された時刻です。
modifierId	String	0123456	命名辞書を最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	命名辞書を最後に変更したユーザーの名前です。
name	String	Shop	命名辞書の表示名です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
uuid	String	obj-123456	命名辞書の UUID です。

テーブルを照会するための FML ステートメント

show tables; レスポンスパラメーター

パラメーター	型	例	説明
code	String	dim_shop	テーブルのコードです。
name	String	Shop table	テーブルの表示名です。
type	Integer	1	テーブルのタイプです。有効な値は以下のとおりです。0：ファクトテーブル1：ディメンションテーブル3：集計テーブル4：アプリケーションテーブル5：ODS テーブル6：ディメンション
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	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
description	String	Description	テーブルの説明です。
config	String	JSON 文字列	テーブルの拡張構成です。
lifeCycle	Integer	365	テーブルのライフサイクルです。
uuid	String	obj-123456	テーブルの UUID です。
gmtCreate	TimeStamp	1644397025000	テーブルが作成された時刻です。
gmtModified	TimeStamp	1644459965000	テーブルが最後に変更された時刻です。
creatorId	String	0123456	テーブルを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	テーブルを作成したユーザーの名前です。
modifierId	String	0123456	テーブルを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	テーブルを最後に変更したユーザーの名前です。

ディメンションテーブルを照会するための FML ステートメント

show dim tables;
レスポンスパラメーター

パラメーター	型	例	説明
code	String	dim_shop	ディメンションテーブルのコードです。
name	String	Shop table	ディメンションテーブルの表示名です。
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	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
description	String	Description	ディメンションテーブルの説明です。
config	String	JSON 文字列	ディメンションテーブルの拡張構成です。
lifeCycle	Integer	365	ディメンションテーブルのライフサイクルです。
uuid	String	obj-123456	ディメンションテーブルの UUID です。
gmtCreate	TimeStamp	1644397025000	ディメンションテーブルが作成された時刻です。
gmtModified	TimeStamp	1644459965000	ディメンションテーブルが最後に変更された時刻です。
creatorId	String	0123456	ディメンションテーブルを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	ディメンションテーブルを作成したユーザーの名前です。
modifierId	String	0123456	ディメンションテーブルを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	ディメンションテーブルを最後に変更したユーザーの名前です。

ファクトテーブルを照会するための FML ステートメント

show fact tables; レスポンスパラメーター

パラメーター	型	例	説明
code	String	dim_shop	ファクトテーブルのコードです。
name	String	Shop table	ファクトテーブルの表示名です。
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	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
description	String	Description	ファクトテーブルの説明です。
config	String	JSON 文字列	ファクトテーブルの拡張構成です。
lifeCycle	Integer	365	ファクトテーブルのライフサイクルです。
uuid	String	obj-123456	ファクトテーブルの UUID です。
gmtCreate	TimeStamp	1644397025000	ファクトテーブルが作成された時刻です。
gmtModified	TimeStamp	1644459965000	ファクトテーブルが最後に変更された時刻です。
creatorId	String	0123456	ファクトテーブルを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	ファクトテーブルを作成したユーザーの名前です。
modifierId	String	0123456	ファクトテーブルを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	ファクトテーブルを最後に変更したユーザーの名前です。

集計テーブルを照会するための FML ステートメント

show dws tables; レスポンスパラメーター

パラメーター	型	例	説明
dataDomainUuid	String	dm-12345	データドメインの UUID です。
dataDomainCode	String	member	データドメインのコードです。
dataDomainName	String	Member	データドメインの名前です。
timePeriods	List	[{"uuid": "uuid", "code": "code", "name": "Display name"}]	集計テーブルの期間です。
uuid	String	obj-123456	集計テーブルの UUID です。
code	String	dws_001	集計テーブルの名前です。
name	String	Payment aggregate table	集計テーブルの表示名です。
adjuncts	List	[{"uuid": "uuid", "code": "code", "name": "Display name"}]	集計テーブルの修飾子です。
dimensions	List	[{"uuid": "uuid", "code": "code", "name": "Display name"}]	集計テーブルに関連付けられたディメンションです。
bizEntityUuid	String	dim-123456	ビジネスオブジェクトの UUID です。
bizEntityCode	String	dim_shop	ビジネスオブジェクトの名前の略称です。
bizEntityName	String	Shop table	ビジネスオブジェクトの表示名です。
relUuid	String	dim_a-123456	集計テーブルに関連付けられたディメンションの UUID です。
type	Integer	3	テーブルのタイプです。3（集計テーブル）のみがサポートされています。
detailType	String	dws_normal	テーブルのサブタイプです。有効な値は以下のとおりです。dws_normal：単一粒度集計テーブルdws_advanced：複数粒度集計テーブル
businessProcessUuid	String	bp-123456	ビジネスプロセスの UUID です。
businessUnitUuid	String	bu-123456	業務部門の UUID です。
dataWarehouseLayerUuid	String	ly-123456	データ層の UUID です。
businessCategoryUuid	String	bc-123456	ビジネスカテゴリの UUID です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
description	String	Description	集計テーブルの説明です。
config	String	JSON 文字列	集計テーブルの拡張構成です。
lifeCycle	Integer	365	集計テーブルのライフサイクルです。
gmtCreate	TimeStamp	1644397025000	集計テーブルが作成された時刻です。
gmtModified	TimeStamp	1644459965000	集計テーブルが最後に変更された時刻です。
creatorId	String	0123456	集計テーブルを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	集計テーブルを作成したユーザーの名前です。
modifierId	String	0123456	集計テーブルを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	集計テーブルを最後に変更したユーザーの名前です。

アプリケーションテーブルを照会するための FML ステートメント

show ads tables; レスポンスパラメーター

パラメーター	型	例	説明
dataDomainUuid	String	dm-12345	データドメインの UUID です。
dataDomainCode	String	member	データドメインのコードです。
dataDomainName	String	Member	データドメインの名前です。
timePeriods	List	[{"uuid": "uuid", "code": "code", "name": "Display name"}]	アプリケーションテーブルの期間です。
uuid	String	obj-123456	アプリケーションテーブルの UUID です。
code	String	dws_001	アプリケーションテーブルの名前です。
name	String	Payment application table	アプリケーションテーブルの表示名です。
adjuncts	List	[{"uuid": "uuid", "code": "code", "name": "Display name"}]	アプリケーションテーブルの修飾子です。
dimensions	List	[{"uuid": "uuid", "code": "code", "name": "Display name"}]	アプリケーションテーブルに関連付けられたディメンションです。
bizEntityUuid	String	dim-123456	ビジネスオブジェクトの UUID です。
bizEntityCode	String	dim_shop	ビジネスオブジェクトの名前の略称です。
bizEntityName	String	Shop table	ビジネスオブジェクトの表示名です。
relUuid	String	dim_a-123456	アプリケーションテーブルに関連付けられたディメンションの UUID です。
type	Integer	1	テーブルのタイプです。有効な値は以下のとおりです。0：ファクトテーブル1：ディメンションテーブル4：アプリケーションテーブル
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	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
description	String	Description	アプリケーションテーブルの説明です。
config	String	JSON 文字列	アプリケーションテーブルの拡張構成です。
lifeCycle	Integer	365	アプリケーションテーブルのライフサイクルです。
gmtCreate	TimeStamp	1644397025000	アプリケーションテーブルが作成された時刻です。
gmtModified	TimeStamp	1644459965000	アプリケーションテーブルが最後に変更された時刻です。
creatorId	String	0123456	アプリケーションテーブルを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	アプリケーションテーブルを作成したユーザーの名前です。
modifierId	String	0123456	アプリケーションテーブルを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	アプリケーションテーブルを最後に変更したユーザーの名前です。

テーブルを照会し、各テーブルのフィールドを返す FML ステートメント

show full tables; レスポンスパラメーター

パラメーター	型	例	説明
tableUuid	String	tb-123456	テーブルの UUID です。
tableCode	String	dim_shop	テーブルのコードです。
tableName	String	Shop table	テーブルの名前です。
columnCode	String	shop_id	カラムのコードです。
columnName	String	Shop ID	カラムの名前です。
columnUuid	String	col-123456	カラムの UUID です。
columnType	String	STRING	カラムのデータの型です。
columnCategory	String	ATTRIBUTE	カラムのタイプです。

テーブルのカラムに関する情報を照会するための FML ステートメント

show columns from table_code; レスポンスパラメーター

パラメーター	型	例	説明
code	String	seller_id	カラムのコードです。
name	String	Seller ID	カラムの表示名です。
dataType	String	STRING	カラムのデータの型です。
type	String	ATTRIBUTE	フィールドのタイプです。
isPrimaryKey	Boolean	false	フィールドがプライマリキー列であるかどうかを示します。
isPartitionKey	Boolean	false	フィールドがパーティションキー列であるかどうかを示します。
partitionOrder	Integer	1	パーティションキー列の順序です。
notNull	Boolean	true	フィールドが NULL 以外であるかどうかを示します。
dataDictionaryUuid	String	member_id	データディクショナリの UUID です。
dataDictionaryCode	String	Member ID	データディクショナリの名前です。
codeTableUuid	String	cd-123456	関連付けられたルックアップテーブルの UUID です。
codeTableCode	String	sex	関連付けられたルックアップテーブルのコードです。
codeTableName	String	Gender	関連付けられたルックアップテーブルの名前です。
measureUnitCode	String	percent	関連付けられた測定単位のコードです。
measureUnitName	String	Percent	関連付けられた測定単位の名前です。
sourceProjectName	String	autotest	ソースワークスペースの名前です。
sourceTableCode	String	dict	ソーステーブルのコードです。
sourceColumnCode	String	age	ソースフィールドのコードです。
sourceRelationTag	String	label	ソース関係のタグです。
description	String	Description	フィールドの説明です。
orderId	String	1	フィールドの順序です。
columnGroupName	Integer	col_group_1	フィールドが属するグループの名前です。
config	String	JSON 文字列	フィールドの拡張構成です。
uuid	String	obj-123456	フィールドの UUID です。
gmtCreate	TimeStamp	1644397025000	フィールドが作成された時刻です。
gmtModified	TimeStamp	1644459965000	フィールドが最後に変更された時刻です。
creatorId	String	0123456	フィールドを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	フィールドを作成したユーザーの名前です。
modifierId	String	0123456	フィールドを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	フィールドを最後に変更したユーザーの名前です。

修飾子を照会するための FML ステートメント

show adjuncts; レスポンスパラメーター

パラメーター	型	例	説明
businessUnitUuid	String	bu-123456	業務部門の UUID です。
businessUnitCode	String	test_bu	業務部門のコードです。
businessUnitName	String	Test	業務部門の名前です。
dataDomainUuid	String	dt-123456	データドメインの UUID です。
dataDomainCode	String	member	データドメインのコードです。
dataDomainName	String	Member	データドメインの名前です。
categoryUuid	String	cy-123456	ビジネスカテゴリの UUID です。
categoryCode	String	trade	ビジネスカテゴリのコードです。
categoryName	String	E-commerce	ビジネスカテゴリの名前です。
type	AdjunctTypeEnum	DIM_VAL	修飾子のタイプです。
code	String	beauty	修飾子の名前の略称です。
name	String	Makeup	修飾子の表示名です。
extendName	String	beauty	修飾子の名前です。
description	String	Description	修飾子の説明です。
bizExpression	String	Statistical criterion	修飾子の統計基準です。
expression	String	beauty = 1	修飾子の式です。
bizEntityUuid	String	dim-123456	ビジネスオブジェクトの UUID です。
bizEntityCode	String	dim_shop	ビジネスオブジェクトの名前の略称です。
bizEntityName	String	Shop table	ビジネスオブジェクトの表示名です。
relUuid	String	dim_a-123456	修飾子に関連付けられたディメンションの UUID です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
uuid	String	obj-123456	修飾子の UUID です。
gmtCreate	TimeStamp	1644397025000	修飾子が作成された時刻です。
gmtModified	TimeStamp	1644459965000	修飾子が最後に変更された時刻です。
creatorId	String	0123456	修飾子を作成したユーザーの ID です。
creatorName	String	A、B、C、および D	修飾子を作成したユーザーの名前です。
modifierId	String	0123456	修飾子を最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	修飾子を最後に変更したユーザーの名前です。
modifierName	String	A、B、C、D	最後に変更を加えたユーザーの名前。

期間を照会するための FML ステートメント

show time_periods; レスポンスパラメーター

パラメーター	型	例	説明
businessUnitUuid	String	bu-123456	期間が属する業務部門の UUID です。
businessUnitCode	String	test_bu	業務部門のコードです。
type	TimePeriodTypeEnum	DAY	期間のタイプです。
typeName	String	Day	期間のタイプの名前です。
code	String	1d	期間の名前の略称です。
name	String	One day	期間の表示名です。
extendName	String	1d	期間の名前です。
description	String	Description	期間の説明です。
isDeleted	DeleteTagEnum	NO	期間が削除されたかどうかを示します。
timeBegin	String	start_expression	開始時刻の式です。
timeEnd	String	end_expression	終了時刻の式です。
gmtCreate	TimeStamp	1633885261000	期間が作成された時刻です。
gmtModified	TimeStamp	1633885261000	期間が最後に変更された時刻です。
modifierId	String	0123456	期間を最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	期間を最後に変更したユーザーの名前です。
ownerId	String	0123456	所有者 ID です。
ownerName	String	A、B、C、および D	所有者の名前です。
beginOffset	Integer	1	開始時刻のオフセットです。
endOffset	Integer	1	終了時刻のオフセットです。
firstDay	Integer	1	期間の最初の日です。このパラメーターは、期間のタイプが WEEK、MONTH、QUARTER、または YEAR に設定されている場合に返されます。期間のタイプが WEEK に設定されている場合の有効な値：1～7（それぞれ日曜日、月曜日、火曜日、水曜日、木曜日、金曜日、土曜日を示します）。期間のタイプが MONTH に設定されている場合の有効な値：1、99、および 2～27。値 1 は月の最初の日を示し、値 99 は月の最終日を示し、値 2～27 は月の 2 日目から 27 日目を示します。期間のタイプが QUARTER に設定されている場合の有効な値：0～11（それぞれ 1 月から 12 月を示します）。期間のタイプが YEAR に設定されている場合の有効な値：0～11（それぞれ 1 月から 12 月を示します）。
uuid	String	obj-123456	期間の UUID です。
creatorId	String	0123456	期間を作成したユーザーの ID です。
creatorName	String	A、B、C、および D	期間を作成したユーザーの名前です。

アトミックメトリクスを照会するための FML ステートメント

show atomic indicators; レスポンスパラメーター

パラメーター	型	例	説明
dataDistinct	YesOrNoEnum	YES	統計収集中に重複データが削除されるかどうかを示します。有効な値：YES、NO
aggFunctionType	AggFunctionEnum	SUM	アトミックメトリクスの関数のタイプです。有効な値：SUM、COUNT、AVG、MAX、MIN、RATE、RANK、UNDEFINED
calExpression	String	price	アトミックメトリクスの式です。
dataType	DataTypeNameEnum	TINYINT	アトミックメトリクスによって収集できるデータのタイプです。有効な値：TINYINT、SMALLINT、INT、BIGINT、BINARY、FLOAT、DOUBLE、DECIMAL、VARCHAR、CHAR、STRING、DATE、DATETIME、TIMESTAMP、BOOLEAN、ARRAY、MAP、STRUCT、および JSON
dataRound	String	N	小数点以下の桁数です。有効な値：N、M
dataUnitUuid	String	du-123456	メトリック単位の UUID です。
dataUnitCode	String	percent	メトリック単位のコードです。
dataUnitName	String	Fen	メトリック単位の名前です。
bizExpression	String	Aggregation of payment amount	統計基準です。
dataRollUpType	String	AGG_FUNCTION	データロールアップのメソッドです。有効な値：AGG_FUNCTION、SUM_THEN_RATE、RATE_THEN_AVG、NOT_SUPPORT
businessUnitUuid	String	bu-0001	業務部門の UUID です。
businessUnitCode	String	project_code	業務部門のコードです。
businessProcessUuid	String	di-0002	ビジネスプロセスの UUID です。
businessProcessCode	String	pay	ビジネスプロセスのコードです。
businessProcessName	String	Payment	ビジネスプロセスの名前です。
dataDomainUuid	String	di-0003	データドメインの UUID です。
dataDomainCode	String	trd	データドメインのコードです。
dataDomainName	String	Transaction	データドメインの名前です。
categoryUuid	String	di-0001	ビジネスカテゴリの UUID です。
categoryCode	String	tb	ビジネスカテゴリのコードです。
categoryName	String	Taobao	ビジネスカテゴリの名前です。
type	String	ATOMIC	メトリックのタイプです。有効な値：ATOMIC、DERIVATIVE、DERIVATIVE_COMPOSITE
code	String	pay_amt	アトミックメトリクスの名前の略称です。
name	String	Payment amount	アトミックメトリクスの表示名です。
extendName	String	pay amount	アトミックメトリクスの名前です。
description	String	remark	アトミックメトリクスの説明です。
status	String	NORMAL	アトミックメトリクスのステータスです。有効な値：DRAFT、DEV、NORMAL
ownerId	String	0001	所有者 ID です。
ownerName	String	Owner name	所有者の名前です。
isDeleted	DeleteTagEnum	NO	アトミックメトリクスが削除されたかどうかを示します。有効な値：YES、NO
uuid	String	obj-123456	アトミックメトリクスの UUID です。
gmtCreate	TimeStamp	1644397025000	アトミックメトリクスが作成された時刻です。
gmtModified	TimeStamp	1644459965000	アトミックメトリクスが最後に変更された時刻です。
creatorId	String	0123456	アトミックメトリクスを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	アトミックメトリクスを作成したユーザーの名前です。
modifierId	String	0123456	アトミックメトリクスを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	アトミックメトリクスを最後に変更したユーザーの名前です。

派生メトリクスを照会するための FML ステートメント

show derivative indicators; レスポンスパラメーター

パラメーター	型	例	説明
timePeriodUuid	String	tp-0001	期間の UUID です。
timePeriodCode	String	1d	期間の名前の略称です。
timePeriodName	String	Last day	期間の表示名です。
adjunctUuids	List	["adj-001"]	修飾子の UUID です。
adjunctCodes	List	["male"]	修飾子の名前の略称です。
adjunctNames	List	Male	修飾子の表示名です。
atomicIndicatorUuid	String	ind-a-0001	アトミックメトリクスの UUID です。
atomicIndicatorCode	String	pay_amt	アトミックメトリクスの名前の略称です。
atomicIndicatorName	String	Payment amount	アトミックメトリクスの表示名です。
dataType	DataTypeNameEnum	BIGINT	派生メトリクスによって収集できるデータのタイプです。有効な値：TINYINT、SMALLINT、INT、BIGINT、BINARY、FLOAT、DOUBLE、DECIMAL、VARCHAR、CHAR、STRING、DATE、DATETIME、TIMESTAMP、BOOLEAN、ARRAY、MAP、STRUCT、および JSON
bizEntityUuid	String	dim-123456	ビジネスオブジェクトの UUID です。
bizEntityCode	String	dim_shop	ビジネスオブジェクトの名前の略称です。
bizEntityName	String	Shop table	ビジネスオブジェクトの表示名です。
relUuid	String	dim_a-123456	派生メトリクスに関連付けられたディメンションの UUID です。
indHash	String	hash-0001	派生メトリクスの要素のハッシュ値です。
suggestCode	String	pay_amt_1d	派生メトリクスによって使用される推奨コードです。
businessUnitUuid	String	bu-0001	業務部門の UUID です。
businessUnitCode	String	project_code	業務部門のコードです。
businessProcessUuid	String	di-0002	ビジネスプロセスの UUID です。
businessProcessCode	String	pay	ビジネスプロセスのコードです。
businessProcessName	String	Payment	ビジネスプロセスの名前です。
dataDomainUuid	String	di-0003	データドメインの UUID です。
dataDomainCode	String	trd	データドメインのコードです。
dataDomainName	String	Transaction	データドメインの名前です。
categoryUuid	String	di-0001	ビジネスカテゴリの UUID です。
categoryCode	String	tb	ビジネスカテゴリのコードです。
categoryName	String	Taobao	ビジネスカテゴリの名前です。
type	IndicatorTypeEnum	ATOMIC	メトリックのタイプです。有効な値：ATOMIC、DERIVATIVE、DERIVATIVE_COMPOSITE
code	String	pay_amt	派生メトリクスの名前の略称です。
name	String	Payment amount	派生メトリクスの表示名です。
extendName	String	pay amount	派生メトリクスの名前です。
description	String	remark	派生メトリクスの説明です。
status	IndicatorStatusEnum	NORMAL	派生メトリクスのステータスです。有効な値：DRAFT、DEV、NORMAL
ownerId	String	0001	所有者 ID です。
ownerName	String	Owner name	所有者の名前です。
isDeleted	DeleteTagEnum	NO	派生メトリクスが削除されたかどうかを示します。有効な値：YES、NO
uuid	String	obj-123456	派生メトリクスの UUID です。
gmtCreate	TimeStamp	1644397025000	派生メトリクスが作成された時刻です。
gmtModified	TimeStamp	1644459965000	派生メトリクスが最後に変更された時刻です。
creatorId	String	0123456	派生メトリクスを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	派生メトリクスを作成したユーザーの名前です。
modifierId	String	0123456	派生メトリクスを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	派生メトリクスを最後に変更したユーザーの名前です。

複合メトリクスを照会するための FML ステートメント

show derivative composite indicators; レスポンスパラメーター

パラメーター	型	例	説明
businessUnitCode	String	project_code	ワークスペースの名前です。
businessProcessUuid	String	di-0002	ビジネスプロセスの UUID です。
businessProcessCode	String	pay	ビジネスプロセスのコードです。
businessProcessName	String	Payment	ビジネスプロセスの名前です。
dataDomainUuid	String	di-0003	データドメインの UUID です。
dataDomainCode	String	trd	データドメインのコードです。
dataDomainName	String	Transaction	データドメインの名前です。
categoryUuid	String	di-0001	ビジネスカテゴリの UUID です。
categoryCode	String	tb	ビジネスカテゴリのコードです。
categoryName	String	Taobao	ビジネスカテゴリの名前です。
type	String	DERIVATIVE_COMPOSITE	計算ロジックです。有効な値：DERIVATIVE_COMPOSITE および DERIVATIVE_COMPARISON。値 DERIVATIVE_COMPOSITE は計算式を示します。値 DERIVATIVE_COMPARISON は比較を示します。
code	String	pay_amt	複合メトリクスの名前の略称です。
name	String	Payment amount	複合メトリクスの表示名です。
extendName	String	pay amount	複合メトリクスの名前です。
description	String	remark	複合メトリクスの説明です。
calculateExpression	String	{@pay_amt_1d[Last day_Payment amount]}/{@pay_amt_1m[Last 30 days_Payment amount]}	計算式です。
comparisonPeriodType	String	DAY_MOM	比較タイプです。有効な値：DAY_MOM、WEEK_MOM、WEEK_YOY、MONTH_MOM、MONTH_YOY、QUARTER_MOM、YEAR_MOM、および YEAR_YOY。
comparisonIndicatorUuid	String	obj-123456	比較に使用される複合メトリクスの UUID です。
comparisonIndicatorCode	String	pay_amt_1d	比較に使用される複合メトリクスの名前の略称です。
comparisonIndicatorName	String	Last day_Payment amount	比較に使用される複合メトリクスの表示名です。
ownerId	String	0001	複合メトリクスの所有者の ID です。
ownerName	String	Bob	複合メトリクスの所有者の名前です。
isDeleted	DeleteTagEnum	NO	複合メトリクスが削除されたかどうかを示します。有効な値：YES、NO。
uuid	String	obj-123456	複合メトリクスの UUID です。
gmtCreate	TimeStamp	1644397025000	複合メトリクスが作成された時刻です。
gmtModified	TimeStamp	1644459965000	複合メトリクスが最後に変更された時刻です。
creatorId	String	0123456	複合メトリクスを作成したユーザーの ID です。
creatorName	String	A、B、C、および D	複合メトリクスを作成したユーザーの名前です。
modifierId	String	0123456	複合メトリクスを最後に変更したユーザーの ID です。
modifierName	String	A、B、C、および D	複合メトリクスを最後に変更したユーザーの名前です。

単一メトリクスが依存するモデルに関する情報を照会するための FML ステートメント

show statistic indicator table_code; レスポンスパラメーター

パラメーター	型	例	説明
uuid	String	obj-123456	メトリックの UUID です。
code	String	pay_amt	メトリックの名前の略称です。
name	String	Payment amount	メトリックの表示名です。
extendName	String	pay amount	メトリックの名前です。
relations	List	Example	メトリックが依存するモデルに関する情報です。EntityInfo パラメーターの構造は、以下のコードとテーブルで確認できます。

EntityInfo パラメーターのサンプル構造と説明

[
    {
        "uuid": "uuid",
        "code": "code",
        "name": "Display name",
        "extendName": "full name in English",
        "entityType": "EntityTypeEnum.BASE_DERIVATIVE_INDICATOR",
        "entityTypeName": "Entity type name",
        "entitySubType": "DERIVATIVE_INDICATOR",
        "entitySubTypeName": "Entity subtype name",
        "ownerId": "0001",
        "ownerName": "Owner name"
    }
]

パラメーター	型	例	説明
uuid	String	obj-123456	モデルの UUID です。
code	String	dws_001	モデルの名前の略称です。
name	String	Payment aggregate table	モデルの表示名です。
extendName	String	dws_001	モデルの名前です。
entityType	EntityTypeEnum	Table	メトリックのエンティティタイプです。本パラメーターの値には、`TABLE、BASE_ATOMIC_INDICATOR、および BASE_DERIVATIVE_INDICATOR` などが含まれます。
entityTypeName	String	Table	エンティティのタイプ名です。
entitySubType	String	DWS_TABLE	エンティティのサブタイプです。本パラメーターの値には、`DWS_TABLE、ATOMIC_INDICATOR、および DERIVATIVE_INDICATOR` などが含まれます。
entitySubTypeName	String	Aggregate table	エンティティのサブタイプ名です。
ownerId	String	0001	所有者 ID です。
ownerName	String	Bob	所有者の名前です。

例

成功レスポンス

JSONJSON

{
  "RequestId": "4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4",
  "ReturnValue": [
    {
      "test": "test",
      "test2": 1
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Valid.FML.NoPermission	You are not authorized to access the project resources.
400	Valid.FML.OnlySupportQueryStatement	Only FML query statement is supported.
400	Valid.FML.ProjectNotExist	The project does not exist.
400	Valid.FML.StatementNotValid	The FML statement is invalid.
400	Valid.FML.ProductExpired	智能数据建模产品购买已到期
400	Valid.FML.ProductNotActivated	智能数据建模产品未开通
500	Execute.FML.ProcessError	Failed to execute FML statement.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。