All Products
Search
Document Center

DataWorks:QueryPublicModelEngine

Last Updated:Jun 11, 2026

Mengambil informasi tentang objek Pemodelan Data yang dibuat menggunakan pernyataan fast modeling language (FML).

Deskripsi operasi

  • Setiap kali Anda memanggil operasi API ini, Anda harus menggunakan pernyataan FML untuk melakukan kueri informasi tentang objek yang dibuat di Pemodelan Data.

  • Informasi tentang objek dapat dikueri per halaman, kecuali untuk lapisan data, proses bisnis, dan domain data. Anda dapat menambahkan offset ke akhir pernyataan FML. Pernyataan num LIMIT num menentukan offset saat informasi tentang objek dikueri, dan jumlah halaman yang dikembalikan setiap kali. Nilai offset harus berupa kelipatan dari jumlah halaman.

  • Maksimum 1.000 entri dapat dikembalikan setiap kali Anda memanggil operasi API ini.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter

Type

Required

Description

Example

Text

string

Yes

Pernyataan FML yang digunakan untuk melakukan kueri informasi tentang objek yang dibuat di Pemodelan Data. Untuk informasi selengkapnya, lihat Use FML statements to configure and manage data tables. Hanya pernyataan SHOW yang didukung.

show dim tables

ProjectId

string

Yes

ID ruang kerja DataWorks. Anda dapat masuk ke konsol DataWorks dan membuka halaman Workspace untuk melakukan kueri ID.

1234

Elemen respons

Element

Type

Description

Example

object

Parameter respons.

RequestId

string

ID permintaan.

4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4

ReturnValue

array<object>

Informasi yang dikembalikan tentang objek.

object

Informasi yang dikembalikan tentang objek.

Deskripsi respons

Pernyataan FML yang digunakan untuk melakukan kueri lapisan data

show layers;
Parameter respons

ParameterTipeContohDeskripsi
codeStringdwsKode lapisan data.
englishNameStringdwsNama lapisan data.
nameStringDWS layerNama tampilan lapisan data.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
descriptionStringDeskripsi lapisan DWSDeskripsi lapisan data.
uuidStringobj-123456UUID lapisan data.
gmtCreateTimeStamp1644397025000Waktu saat lapisan data dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat lapisan data terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat lapisan data.
creatorNameStringA, B, C, and DNama pengguna yang membuat lapisan data.
modifierIdString0123456ID pengguna yang terakhir memodifikasi lapisan data.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi lapisan data.

Pernyataan FML yang digunakan untuk melakukan kueri domain data

show domains;
Parameter respons

ParameterTipeContohDeskripsi
codeStringmemberKode domain data.
englishNameStringmemberNama domain data.
nameStringMemberNama tampilan domain data.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
businessUnitCodeStringbu-123456Kode unit bisnis.
descriptionStringDeskripsi domain data MemberDeskripsi domain data.
uuidStringobj-123456UUID domain data.
gmtCreateTimeStamp1644397025000Waktu saat domain data dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat domain data terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat domain data.
creatorNameStringA, B, C, and DNama pengguna yang membuat domain data.
modifierIdString0123456ID pengguna yang terakhir memodifikasi domain data.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi domain data.

Pernyataan FML yang digunakan untuk melakukan kueri proses bisnis

  • Pernyataan FML yang digunakan untuk melakukan kueri proses bisnis tanpa mengonfigurasi kondisi kueri: show business_processes;

  • Pernyataan FML yang digunakan untuk melakukan kueri proses bisnis berdasarkan kode proses bisnis: show business_processes where code='bp-code';

  • Pernyataan FML yang digunakan untuk melakukan kueri proses bisnis berdasarkan kode domain data: show business_processes where data_domain='dm-code';

Parameter respons

ParameterTipeContohDeskripsi
codeStringbp-123456Kode proses bisnis.
englishNameStringpayNama proses bisnis.
nameStringPaymentNama tampilan proses bisnis.
dataDomainCodeStringtradeKode domain data yang menjadi tempat proses bisnis berada.
dataDomainNameStringTransactionNama tampilan domain data yang menjadi tempat proses bisnis berada.
dataDomainUuidStringdm-123456UUID domain data yang menjadi tempat proses bisnis berada.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
descriptionStringPaymentDeskripsi proses bisnis.
sourceInteger2Sumber proses bisnis. Nilai yang valid:1: menunjukkan bahwa proses bisnis dibuat oleh sistem.2: menunjukkan bahwa proses bisnis dibuat oleh pengguna.
uuidStringobj-123456UUID proses bisnis.
gmtCreateTimeStamp1644397025000Waktu saat proses bisnis dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat proses bisnis terakhir dimodifikasi.
creatorIdStringcreatorIdID pengguna yang membuat proses bisnis.
creatorNameStringA, B, C, and DNama pengguna yang membuat proses bisnis.
modifierIdString0123456ID pengguna yang terakhir memodifikasi proses bisnis.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi proses bisnis.

Pernyataan FML yang digunakan untuk melakukan kueri kategori bisnis

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

Parameter respons

ParameterTipeContohDeskripsi
categoryDetailDirectoryDetailDTO{"uuid": "cate_uuid", "code": "trd", "name": "Transaction"}Detail kategori bisnis.
nameStringE-commerceNama direktori.
detailTypeStringDICTTipe direktori.
parentUuidStringdy-123456UUID direktori induk.
descriptionStringDeskripsiDeskripsi direktori.
codeStringindKode kategori bisnis.
dataDomainsList[{"uuid": "domain1", "code": "trd", "name": "Transaction data domain"}]Domain data yang terkait dengan kategori bisnis.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
businessUnitCodeStringbu-123456Kode unit bisnis.
descriptionStringDeskripsiDeskripsi direktori.
categoryPathStringtm.indPath kategori bisnis.

Pernyataan FML yang digunakan untuk melakukan kueri data mart

show markets; Parameter respons

ParameterTipeContohDeskripsi
categoryDetailDirectoryDetailDTO{"uuid": "cate_uuid", "code": "trd", "name": "Transaction"}Detail data mart.
nameStringE-commerceNama direktori.
detailTypeStringDICTTipe direktori.
parentUuidStringdy-123456UUID direktori induk.
descriptionStringDeskripsiDeskripsi direktori.
codeStringindKode kategori bisnis.
subDetailTypeStringcommonSubtipe direktori.
auditDTOListList[{"baseId":"123","showName":"test"}]Para peninjau.
codeStringmemberKode domain data.
englishNameStringmemberNama domain data.
nameStringMemberNama tampilan domain data.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
businessUnitCodeStringbu-123456Kode unit bisnis.
descriptionStringDeskripsi domain data MemberDeskripsi domain data.
auditDTOListList[{"baseId":"123","showName":"test"}]Para peninjau.
categoryPathStringtm.indPath kategori bisnis.

Pernyataan FML yang digunakan untuk melakukan kueri area subjek

show subjects; Parameter respons

ParameterTipeContohDeskripsi
categoryDetailDirectoryDetailDTO{"uuid": "cate_uuid", "code": "trd", "name": "Transaction"}Detail area subjek.
nameStringE-commerceNama direktori.
detailTypeStringDICTTipe direktori.
parentUuidStringdy-123456UUID direktori induk.
descriptionStringDeskripsiDeskripsi direktori.
codeStringindKode kategori bisnis.
subDetailTypeStringcommonSubtipe direktori.
auditDTOListList[{"baseId":"123","showName":"test"}]Para peninjau.
codeStringmemberKode domain data.
englishNameStringmemberNama domain data.
nameStringMemberNama tampilan domain data.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
businessUnitCodeStringbu-123456Kode unit bisnis.
descriptionStringDeskripsi domain data MemberDeskripsi area subjek.
auditDTOListList[{"baseId":"123","showName":"test"}]Para peninjau.
categoryPathStringtm.indPath kategori bisnis.

Pernyataan FML yang digunakan untuk melakukan kueri set standar data

show dict groups; Parameter respons

ParameterTipeContohDeskripsi
nameStringE-commerceNama direktori.
detailTypeStringDICTTipe direktori.
parentUuidStringdy-123456UUID direktori induk.
descriptionStringDeskripsiDeskripsi direktori.
codeStringindKode kategori bisnis.
uuidListobj-123456UUID set standar data.
gmtCreateTimeStamp1644397025000Waktu saat set standar data dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat set standar data terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat set standar data.
creatorNameStringA, B, C, and DNama pengguna yang membuat set standar data.
modifierIdString0123456ID pengguna yang terakhir memodifikasi set standar data.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi set standar data.

Pernyataan FML yang digunakan untuk melakukan kueri standar data

show dicts; Parameter respons

ParameterTipeContohDeskripsi
codeStringshop_typeSingkatan untuk nama standar data.
englishNameStringshop typeNama standar data.
nameStringShop typeNama tampilan standar data.
noStringSN00001ID standar data.
dataTypeStringSTRINGTipe data bidang yang menggunakan standar data.
lengthInteger10Jumlah digit maksimum dalam nilai bidang yang menggunakan standar data.
numericalPrecisionInteger2Jumlah desimal yang dipertahankan dalam nilai bidang yang menggunakan standar data.
notNullBooleanfalseMenunjukkan apakah nilai bidang yang menggunakan standar data dapat bersifat non-null.
defaultValueStringFlagship shopNilai default.
parentNoStringSN0001ID standar data induk.
parentNameStringShopNama standar data induk.
codeTableNoStringshop_typeKode tabel pencarian yang menentukan rentang nilai bidang yang menggunakan standar data.
codeTableNameStringShop typeNama tabel pencarian yang menentukan rentang nilai bidang yang menggunakan standar data.
codeTableUuidStringtb-0001UUID tabel pencarian yang menentukan rentang nilai bidang yang menggunakan standar data.
directoryUuidStringDirectory UUIDUUID direktori tempat standar data disimpan.
directoryNameStringShop directoryNama direktori tempat standar data disimpan.
descriptionStringremarkDeskripsi standar data.
uuidStringobj-123456UUID standar data.
gmtCreateTimeStamp1644397025000Waktu saat standar data dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat standar data terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat standar data.
creatorNameStringA, B, C, and DNama pengguna yang membuat standar data.
modifierIdString0123456ID pengguna yang terakhir memodifikasi standar data.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi standar data.

Pernyataan FML yang digunakan untuk melakukan kueri tabel pencarian

show code tables; Parameter respons

ParameterTipeContohDeskripsi
codeStringshop_typeKode tabel pencarian.
nameStringShop typeNama tampilan tabel pencarian.
extendNameStringshop typeNama tabel pencarian.
descriptionStringremarkDeskripsi tabel pencarian.
uuidStringobj-123456UUID tabel pencarian.
gmtCreateTimeStamp1644397025000Waktu saat tabel pencarian dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat tabel pencarian terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat tabel pencarian.
creatorNameStringA, B, C, and DNama pengguna yang membuat tabel pencarian.
modifierIdString0123456ID pengguna yang terakhir memodifikasi tabel pencarian.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi tabel pencarian.

Pernyataan FML yang digunakan untuk melakukan kueri grup unit pengukuran

show measure_unit groups; Parameter respons

ParameterTipeContohDeskripsi
nameStringE-commerceNama direktori.
detailTypeStringDICTTipe direktori.
parentUuidStringdy-123456UUID direktori induk.
descriptionStringDeskripsiDeskripsi direktori.
codeStringindKode kategori bisnis.
uuidStringobj-123456UUID grup unit pengukuran.
gmtCreateTimeStamp1644397025000Waktu saat grup unit pengukuran dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat grup unit pengukuran terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat grup unit pengukuran.
creatorNameStringA, B, C, and DNama pengguna yang membuat grup unit pengukuran.
modifierIdString0123456ID pengguna yang terakhir memodifikasi grup unit pengukuran.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi grup unit pengukuran.

Pernyataan FML yang digunakan untuk melakukan kueri unit pengukuran

show measure_units; Parameter respons

ParameterTipeContohDeskripsi
codeStringyuanSingkatan untuk nama unit pengukuran.
englishNameStringRMBNama unit pengukuran.
nameStringYuanNama tampilan unit pengukuran.
directoryUuidStringdi-0001UUID grup unit pengukuran tempat unit pengukuran berada.
directoryNameStringCurrencyNama grup unit pengukuran tempat unit pengukuran berada.
descriptionStringremarkDeskripsi unit pengukuran.
uuidStringobj-123456UUID unit pengukuran.
gmtCreateTimeStamp1644397025000Waktu saat unit pengukuran dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat unit pengukuran terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat unit pengukuran.
creatorNameStringA, B, C, and DNama pengguna yang membuat unit pengukuran.
modifierIdString0123456ID pengguna yang terakhir memodifikasi unit pengukuran.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi unit pengukuran.

Pernyataan FML yang digunakan untuk melakukan kueri data tabel pencarian

show codes from code_table; Parameter respons

ParameterTipeContohDeskripsi
codeContentString0Konten tabel pencarian.
extendNameContentStringfemaleNama tampilan tabel pencarian.
nameContentStringFemaleNama tabel pencarian.
descriptionStringremarkDeskripsi tabel pencarian.
uuidStringobj-123456UUID tabel pencarian.
gmtCreateTimeStamp1644397025000Waktu saat tabel pencarian dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat tabel pencarian terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat tabel pencarian.
creatorNameStringA, B, C, and DNama pengguna yang membuat tabel pencarian.
modifierIdString0123456ID pengguna yang terakhir memodifikasi tabel pencarian.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi tabel pencarian.

Pernyataan FML yang digunakan untuk melakukan kueri kamus penamaan

show naming dicts; Parameter respons

ParameterTipeContohDeskripsi
codeStringshopSingkatan untuk nama kamus penamaan.
creatorIdString0123456ID pengguna yang membuat kamus penamaan.
creatorNameStringA, B, C, and DNama pengguna yang membuat kamus penamaan.
extendNameStringshopNama kamus penamaan.
gmtCreateTimeStamp1644397025000Waktu saat kamus penamaan dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat kamus penamaan terakhir dimodifikasi.
modifierIdString0123456ID pengguna yang terakhir memodifikasi kamus penamaan.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi kamus penamaan.
nameStringShopNama tampilan kamus penamaan.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
uuidStringobj-123456UUID kamus penamaan.

Pernyataan FML yang digunakan untuk melakukan kueri tabel

show tables; Parameter respons

ParameterTipeContohDeskripsi
codeStringdim_shopKode tabel.
nameStringShop tableNama tampilan tabel.
typeInteger1Tipe tabel. Nilai yang valid:0: tabel fakta1: tabel dimensi3: tabel agregat4: tabel aplikasi5: tabel ODS6: dimensi
detailTypeStringnormalSubtipe tabel. Nilai yang valid:Tabel dimensi umumTabel dimensi enumerasiTabel fakta transaksi
businessProcessUuidStringbp-123456UUID proses bisnis.
businessUnitUuidStringbu-123456UUID unit bisnis.
dataWarehouseLayerUuidStringly-123456UUID lapisan data.
businessCategoryUuidStringbc-123456UUID kategori bisnis.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
descriptionStringDeskripsiDeskripsi tabel.
configStringJSON stringKonfigurasi tambahan untuk tabel.
lifeCycleInteger365Siklus hidup tabel.
uuidStringobj-123456UUID tabel.
gmtCreateTimeStamp1644397025000Waktu saat tabel dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat tabel terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat tabel.
creatorNameStringA, B, C, and DNama pengguna yang membuat tabel.
modifierIdString0123456ID pengguna yang terakhir memodifikasi tabel.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi tabel.

Pernyataan FML yang digunakan untuk melakukan kueri tabel dimensi

show dim tables;
Parameter respons

ParameterTipeContohDeskripsi
codeStringdim_shopKode tabel dimensi.
nameStringShop tableNama tampilan tabel dimensi.
typeInteger1Tipe tabel. Nilai yang valid:0: tabel fakta1: tabel dimensi
detailTypeStringnormalSubtipe tabel. Nilai yang valid:Tabel dimensi umumTabel dimensi enumerasi
businessProcessUuidStringbp-123456UUID proses bisnis.
businessUnitUuidStringbu-123456UUID unit bisnis.
dataWarehouseLayerUuidStringly-123456UUID lapisan data.
businessCategoryUuidStringbc-123456UUID kategori bisnis.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
descriptionStringDeskripsiDeskripsi tabel dimensi.
configStringJSON stringKonfigurasi tambahan untuk tabel dimensi.
lifeCycleInteger365Siklus hidup tabel dimensi.
uuidStringobj-123456UUID tabel dimensi.
gmtCreateTimeStamp1644397025000Waktu saat tabel dimensi dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat tabel dimensi terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat tabel dimensi.
creatorNameStringA, B, C, and DNama pengguna yang membuat tabel dimensi.
modifierIdString0123456ID pengguna yang terakhir memodifikasi tabel dimensi.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi tabel dimensi.

Pernyataan FML yang digunakan untuk melakukan kueri tabel fakta

show fact tables; Parameter respons

ParameterTipeContohDeskripsi
codeStringdim_shopKode tabel fakta.
nameStringShop tableNama tampilan tabel fakta.
typeInteger1Tipe tabel. Nilai yang valid:0: tabel fakta1: tabel dimensi
detailTypeStringnormalSubtipe tabel. Hanya tabel fakta transaksi yang didukung.
businessProcessUuidStringbp-123456UUID proses bisnis.
businessUnitUuidStringbu-123456UUID unit bisnis.
dataWarehouseLayerUuidStringly-123456UUID lapisan data.
businessCategoryUuidStringbc-123456UUID kategori bisnis.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
descriptionStringDeskripsiDeskripsi tabel fakta.
configStringJSON stringKonfigurasi tambahan untuk tabel fakta.
lifeCycleInteger365Siklus hidup tabel fakta.
uuidStringobj-123456UUID tabel fakta.
gmtCreateTimeStamp1644397025000Waktu saat tabel fakta dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat tabel fakta terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat tabel fakta.
creatorNameStringA, B, C, and DNama pengguna yang membuat tabel fakta.
modifierIdString0123456ID pengguna yang terakhir memodifikasi tabel fakta.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi tabel fakta.

Pernyataan FML yang digunakan untuk melakukan kueri tabel agregat

show dws tables; Parameter respons

ParameterTipeContohDeskripsi
dataDomainUuidStringdm-12345UUID domain data.
dataDomainCodeStringmemberKode domain data.
dataDomainNameStringMemberNama domain data.
timePeriodsList[{"uuid": "uuid", "code": "code", "name": "Display name"}]Periode untuk tabel agregat.
uuidStringobj-123456UUID tabel agregat.
codeStringdws_001Nama tabel agregat.
nameStringPayment aggregate tableNama tampilan tabel agregat.
adjunctsList[{"uuid": "uuid", "code": "code", "name": "Display name"}]Pengubah untuk tabel agregat.
dimensionsList[{"uuid": "uuid", "code": "code", "name": "Display name"}]Dimensi yang terkait dengan tabel agregat.
bizEntityUuidStringdim-123456UUID objek bisnis.
bizEntityCodeStringdim_shopSingkatan untuk nama objek bisnis.
bizEntityNameStringShop tableNama tampilan objek bisnis.
relUuidStringdim_a-123456UUID dimensi yang terkait dengan tabel agregat.
typeInteger3Tipe tabel. Hanya 3 (tabel agregat) yang didukung.
detailTypeStringdws_normalSubtipe tabel. Nilai yang valid:dws_normal: tabel agregat granularitas tunggaldws_advanced: tabel agregat multi-granularitas
businessProcessUuidStringbp-123456UUID proses bisnis.
businessUnitUuidStringbu-123456UUID unit bisnis.
dataWarehouseLayerUuidStringly-123456UUID lapisan data.
businessCategoryUuidStringbc-123456UUID kategori bisnis.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
descriptionStringDeskripsiDeskripsi tabel agregat.
configStringJSON stringKonfigurasi tambahan untuk tabel agregat.
lifeCycleInteger365Siklus hidup tabel agregat.
gmtCreateTimeStamp1644397025000Waktu saat tabel agregat dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat tabel agregat terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat tabel agregat.
creatorNameStringA, B, C, and DNama pengguna yang membuat tabel agregat.
modifierIdString0123456ID pengguna yang terakhir memodifikasi tabel agregat.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi tabel agregat.

Pernyataan FML yang digunakan untuk melakukan kueri tabel aplikasi

show ads tables; Parameter respons

ParameterTipeContohDeskripsi
dataDomainUuidStringdm-12345UUID domain data.
dataDomainCodeStringmemberKode domain data.
dataDomainNameStringMemberNama domain data.
timePeriodsList[{"uuid": "uuid", "code": "code", "name": "Display name"}]Periode untuk tabel aplikasi.
uuidStringobj-123456UUID tabel aplikasi.
codeStringdws_001Nama tabel aplikasi.
nameStringPayment application tableNama tampilan tabel aplikasi.
adjunctsList[{"uuid": "uuid", "code": "code", "name": "Display name"}]Pengubah untuk tabel aplikasi.
dimensionsList[{"uuid": "uuid", "code": "code", "name": "Display name"}]Dimensi yang terkait dengan tabel aplikasi.
bizEntityUuidStringdim-123456UUID objek bisnis.
bizEntityCodeStringdim_shopSingkatan untuk nama objek bisnis.
bizEntityNameStringShop tableNama tampilan objek bisnis.
relUuidStringdim_a-123456UUID dimensi yang terkait dengan tabel aplikasi.
typeInteger1Tipe tabel. Nilai yang valid:0: tabel fakta1: tabel dimensi4: application table
detailTypeStringnormalSubtipe tabel. Nilai yang valid:Tabel dimensi umumTabel dimensi enumerasiTabel fakta transaksi
businessProcessUuidStringbp-123456UUID proses bisnis.
businessUnitUuidStringbu-123456UUID unit bisnis.
dataWarehouseLayerUuidStringly-123456UUID lapisan data.
businessCategoryUuidStringbc-123456UUID kategori bisnis.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
descriptionStringDeskripsiDeskripsi tabel aplikasi.
configStringJSON stringKonfigurasi tambahan untuk tabel aplikasi.
lifeCycleInteger365Siklus hidup tabel aplikasi.
gmtCreateTimeStamp1644397025000Waktu saat tabel aplikasi dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat tabel aplikasi terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat tabel aplikasi.
creatorNameStringA, B, C, and DNama pengguna yang membuat tabel aplikasi.
modifierIdString0123456ID pengguna yang terakhir memodifikasi tabel aplikasi.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi tabel aplikasi.

Pernyataan FML yang digunakan untuk melakukan kueri tabel and return the fields of each table

show full tables; Parameter respons

ParameterTipeContohDeskripsi
tableUuidStringtb-123456UUID tabel.
tableCodeStringdim_shopKode tabel.
tableNameStringShop tableNama tabel.
columnCodeStringshop_idKode kolom.
columnNameStringShop IDNama kolom.
columnUuidStringcol-123456UUID kolom.
columnTypeStringSTRINGTipe data kolom.
columnCategoryStringATTRIBUTETipe kolom.

Pernyataan FML yang digunakan untuk melakukan kueri informasi tentang kolom suatu tabel

show columns from table_code; Parameter respons

ParameterTipeContohDeskripsi
codeStringseller_idKode kolom.
nameStringSeller IDNama tampilan kolom.
dataTypeStringSTRINGTipe data kolom.
typeStringATTRIBUTETipe bidang.
isPrimaryKeyBooleanfalseMenunjukkan apakah bidang adalah kolom kunci primer.
isPartitionKeyBooleanfalseMenunjukkan apakah bidang adalah kolom kunci partisi.
partitionOrderInteger1Urutan kolom kunci partisi.
notNullBooleantrueMenunjukkan apakah bidang bersifat non-null.
dataDictionaryUuidStringmember_idUUID kamus data.
dataDictionaryCodeStringMember IDNama kamus data.
codeTableUuidStringcd-123456UUID tabel pencarian yang terkait.
codeTableCodeStringsexKode tabel pencarian yang terkait.
codeTableNameStringGenderNama tabel pencarian yang terkait.
measureUnitCodeStringpercentKode unit pengukuran yang terkait.
measureUnitNameStringPercentNama unit pengukuran yang terkait.
sourceProjectNameStringautotestNama ruang kerja sumber.
sourceTableCodeStringdictKode tabel sumber.
sourceColumnCodeStringageKode bidang sumber.
sourceRelationTagStringlabelTag relasi sumber.
descriptionStringDeskripsiDeskripsi bidang.
orderIdString1Urutan bidang.
columnGroupNameIntegercol_group_1Nama grup tempat bidang berada.
configStringJSON stringKonfigurasi tambahan untuk bidang.
uuidStringobj-123456UUID bidang.
gmtCreateTimeStamp1644397025000Waktu saat bidang dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat bidang terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat bidang.
creatorNameStringA, B, C, and DNama pengguna yang membuat bidang.
modifierIdString0123456ID pengguna yang terakhir memodifikasi bidang.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi bidang.

Pernyataan FML yang digunakan untuk melakukan kueri pengubah (modifier)

show adjuncts; Parameter respons

ParameterTipeContohDeskripsi
businessUnitUuidStringbu-123456UUID unit bisnis.
businessUnitCodeStringtest_buKode unit bisnis.
businessUnitNameStringTestNama unit bisnis.
dataDomainUuidStringdt-123456UUID domain data.
dataDomainCodeStringmemberKode domain data.
dataDomainNameStringMemberNama domain data.
categoryUuidStringcy-123456UUID kategori bisnis.
categoryCodeStringtradeKode kategori bisnis.
categoryNameStringE-commerceNama kategori bisnis.
typeAdjunctTypeEnumDIM_VALTipe pengubah.
codeStringbeautySingkatan untuk nama pengubah.
nameStringMakeupNama tampilan pengubah.
extendNameStringbeautyNama pengubah.
descriptionStringDeskripsiDeskripsi pengubah.
bizExpressionStringStatistical criterionKriteria statistik pengubah.
expressionStringbeauty = 1Ekspresi pengubah.
bizEntityUuidStringdim-123456UUID objek bisnis.
bizEntityCodeStringdim_shopSingkatan untuk nama objek bisnis.
bizEntityNameStringShop tableNama tampilan objek bisnis.
relUuidStringdim_a-123456UUID dimensi yang terkait dengan pengubah.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
isDeletedDeleteTagEnumNOMenunjukkan apakah pengubah telah dihapus.
uuidStringobj-123456UUID pengubah.
gmtCreateTimeStamp1644397025000Waktu saat pengubah dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat pengubah terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat pengubah.
creatorNameStringA, B, C, and DNama pengguna yang membuat pengubah.
modifierIdString0123456ID pengguna yang terakhir memodifikasi pengubah.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi pengubah.

Pernyataan FML yang digunakan untuk melakukan kueri periode

show time_periods; Parameter respons

ParameterTipeContohDeskripsi
businessUnitUuidStringbu-123456UUID unit bisnis tempat periode berada.
businessUnitCodeStringtest_buKode unit bisnis.
typeTimePeriodTypeEnumDAYTipe periode.
typeNameStringDayNama tipe periode.
codeString1dSingkatan untuk nama periode.
nameStringOne dayNama tampilan periode.
extendNameString1dNama periode.
descriptionStringDeskripsiDeskripsi periode.
isDeletedDeleteTagEnumNOMenunjukkan apakah periode telah dihapus.
timeBeginStringstart_expressionEkspresi untuk waktu mulai.
timeEndStringend_expressionEkspresi untuk waktu akhir.
gmtCreateTimeStamp1633885261000Waktu saat periode dibuat.
gmtModifiedTimeStamp1633885261000Waktu saat periode terakhir dimodifikasi.
modifierIdString0123456ID pengguna yang terakhir memodifikasi periode.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi periode.
ownerIdString0123456ID pemilik.
ownerNameStringA, B, C, and DNama pemilik.
beginOffsetInteger1Offset waktu mulai.
endOffsetInteger1Offset waktu akhir.
firstDayInteger1Hari pertama dalam periode. Parameter ini dikembalikan jika tipe periode disetel ke WEEK, MONTH, QUARTER, atau YEAR. Nilai yang valid jika tipe periode disetel ke WEEK: 1 hingga 7, yang menunjukkan Minggu, Senin, Selasa, Rabu, Kamis, Jumat, dan Sabtu. Nilai yang valid jika tipe periode disetel ke MONTH: 1, 99, dan 2 hingga 27. Nilai 1 menunjukkan hari pertama dalam bulan, nilai 99 menunjukkan akhir bulan, dan nilai dari 2 hingga 27 menunjukkan hari ke-2 hingga ke-27 dalam bulan. Nilai yang valid jika tipe periode disetel ke QUARTER: 0 hingga 11, yang menunjukkan Januari hingga Desember. Nilai yang valid jika tipe periode disetel ke YEAR: 0 hingga 11, yang menunjukkan Januari hingga Desember.
uuidStringobj-123456UUID periode.
creatorIdString0123456ID pengguna yang membuat periode.
creatorNameStringA, B, C, and DNama pengguna yang membuat periode.

Pernyataan FML yang digunakan untuk melakukan kueri metrik atomik

show atomic indicators; Parameter respons

ParameterTipeContohDeskripsi
dataDistinctYesOrNoEnumYESMenunjukkan apakah data duplikat dihapus selama pengumpulan statistik. Nilai yang valid:YESNO
aggFunctionTypeAggFunctionEnumSUMTipe fungsi untuk metrik atomik. Nilai yang valid:SUMCOUNTAVGMAXMINRATERANKUNDEFINED
calExpressionStringpriceEkspresi metrik atomik.
dataTypeDataTypeNameEnumTINYINTTipe data yang dapat dikumpulkan oleh metrik atomik. Nilai yang valid: TINYINT, SMALLINT, INT, BIGINT, BINARY, FLOAT, DOUBLE, DECIMAL, VARCHAR, CHAR, STRING, DATE, DATETIME, TIMESTAMP, BOOLEAN, ARRAY, MAP, STRUCT, dan JSON
dataRoundStringNJumlah desimal setelah titik desimal. Nilai yang valid:NM
dataUnitUuidStringdu-123456UUID unit metrik.
dataUnitCodeStringpercentKode unit metrik.
dataUnitNameStringFenNama unit metrik.
bizExpressionStringAggregation of payment amountKriteria statistik.
dataRollUpTypeStringAGG_FUNCTIONMetode roll-up data. Nilai yang valid:AGG_FUNCTIONSUM_THEN_RATERATE_THEN_AVGNOT_SUPPORT
businessUnitUuidStringbu-0001UUID unit bisnis.
businessUnitCodeStringproject_codeKode unit bisnis.
businessProcessUuidStringdi-0002UUID proses bisnis.
businessProcessCodeStringpayKode proses bisnis.
businessProcessNameStringPaymentNama proses bisnis.
dataDomainUuidStringdi-0003UUID domain data.
dataDomainCodeStringtrdKode domain data.
dataDomainNameStringTransactionNama domain data.
categoryUuidStringdi-0001UUID kategori bisnis.
categoryCodeStringtbKode kategori bisnis.
categoryNameStringTaobaoNama kategori bisnis.
typeStringATOMICTipe metrik. Nilai yang valid:ATOMICDERIVATIVEDERIVATIVE_COMPOSITE
codeStringpay_amtSingkatan untuk nama metrik atomik.
nameStringPayment amountNama tampilan metrik atomik.
extendNameStringpay amountNama metrik atomik.
descriptionStringremarkDeskripsi metrik atomik.
statusStringNORMALStatus metrik atomik. Nilai yang valid:DRAFTDEVNORMAL
ownerIdString0001ID pemilik.
ownerNameStringOwner nameNama pemilik.
isDeletedDeleteTagEnumNOMenunjukkan apakah metrik atomik telah dihapus. Nilai yang valid:YESNO
uuidStringobj-123456UUID metrik atomik.
gmtCreateTimeStamp1644397025000Waktu saat metrik atomik dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat metrik atomik terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat metrik atomik.
creatorNameStringA, B, C, and DNama pengguna yang membuat metrik atomik.
modifierIdString0123456ID pengguna yang terakhir memodifikasi metrik atomik.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi metrik atomik.

Pernyataan FML yang digunakan untuk melakukan kueri metrik turunan

show derivative indicators; Parameter respons

ParameterTipeContohDeskripsi
timePeriodUuidStringtp-0001UUID periode.
timePeriodCodeString1dSingkatan untuk nama periode.
timePeriodNameStringLast dayNama tampilan periode.
adjunctUuidsList["adj-001"]UUID dari pengubah-pengubah.
adjunctCodesList["male"]Singkatan untuk nama-nama pengubah.
adjunctNamesListMaleNama tampilan dari pengubah-pengubah.
atomicIndicatorUuidStringind-a-0001UUID metrik atomik.
atomicIndicatorCodeStringpay_amtSingkatan untuk nama metrik atomik.
atomicIndicatorNameStringPayment amountNama tampilan metrik atomik.
dataTypeDataTypeNameEnumBIGINTTipe data yang dapat dikumpulkan oleh metrik turunan. Nilai yang valid: TINYINT, SMALLINT, INT, BIGINT, BINARY, FLOAT, DOUBLE, DECIMAL, VARCHAR, CHAR, STRING, DATE, DATETIME, TIMESTAMP, BOOLEAN, ARRAY, MAP, STRUCT, dan JSON
bizEntityUuidStringdim-123456UUID objek bisnis.
bizEntityCodeStringdim_shopSingkatan untuk nama objek bisnis.
bizEntityNameStringShop tableNama tampilan objek bisnis.
relUuidStringdim_a-123456UUID dimensi yang terkait dengan metrik turunan.
indHashStringhash-0001Nilai hash untuk elemen-elemen metrik turunan.
suggestCodeStringpay_amt_1dKode yang direkomendasikan yang digunakan oleh metrik turunan.
businessUnitUuidStringbu-0001UUID unit bisnis.
businessUnitCodeStringproject_codeKode unit bisnis.
businessProcessUuidStringdi-0002UUID proses bisnis.
businessProcessCodeStringpayKode proses bisnis.
businessProcessNameStringPaymentNama proses bisnis.
dataDomainUuidStringdi-0003UUID domain data.
dataDomainCodeStringtrdKode domain data.
dataDomainNameStringTransactionNama domain data.
categoryUuidStringdi-0001UUID kategori bisnis.
categoryCodeStringtbKode kategori bisnis.
categoryNameStringTaobaoNama kategori bisnis.
typeIndicatorTypeEnumATOMICTipe metrik. Nilai yang valid:ATOMICDERIVATIVEDERIVATIVE_COMPOSITE
codeStringpay_amtSingkatan untuk nama metrik turunan.
nameStringPayment amountNama tampilan metrik turunan.
extendNameStringpay amountNama metrik turunan.
descriptionStringremarkDeskripsi metrik turunan.
statusIndicatorStatusEnumNORMALStatus metrik turunan. Nilai yang valid:DRAFTDEVNORMAL
ownerIdString0001ID pemilik.
ownerNameStringOwner nameNama pemilik.
isDeletedDeleteTagEnumNOMenunjukkan apakah metrik turunan telah dihapus. Nilai yang valid:YESNO
uuidStringobj-123456UUID metrik turunan.
gmtCreateTimeStamp1644397025000Waktu saat metrik turunan dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat metrik turunan terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat metrik turunan.
creatorNameStringA, B, C, and DNama pengguna yang membuat metrik turunan.
modifierIdString0123456ID pengguna yang terakhir memodifikasi metrik turunan.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi metrik turunan.

Pernyataan FML yang digunakan untuk melakukan kueri metrik komposit

show derivative composite indicators; Parameter respons

ParameterTipeContohDeskripsi
businessUnitCodeStringproject_codeNama ruang kerja.
businessProcessUuidStringdi-0002UUID proses bisnis.
businessProcessCodeStringpayKode proses bisnis.
businessProcessNameStringPaymentNama proses bisnis.
dataDomainUuidStringdi-0003UUID domain data.
dataDomainCodeStringtrdKode domain data.
dataDomainNameStringTransactionNama domain data.
categoryUuidStringdi-0001UUID kategori bisnis.
categoryCodeStringtbKode kategori bisnis.
categoryNameStringTaobaoNama kategori bisnis.
typeStringDERIVATIVE_COMPOSITELogika komputasi. Nilai yang valid: DERIVATIVE_COMPOSITE dan DERIVATIVE_COMPARISON. Nilai DERIVATIVE_COMPOSITE menunjukkan ekspresi kalkulasi. Nilai DERIVATIVE_COMPARISON menunjukkan perbandingan.
codeStringpay_amtSingkatan untuk nama metrik komposit.
nameStringPayment amountNama tampilan metrik komposit.
extendNameStringpay amountNama metrik komposit.
descriptionStringremarkDeskripsi metrik komposit.
calculateExpressionString{@pay_amt_1d[Last day_Payment amount]}/{@pay_amt_1m[Last 30 days_Payment amount]}Ekspresi kalkulasi.
comparisonPeriodTypeStringDAY_MOMTipe perbandingan. Nilai yang valid: DAY_MOM, WEEK_MOM, WEEK_YOY, MONTH_MOM, MONTH_YOY, QUARTER_MOM, YEAR_MOM, dan YEAR_YOY.
comparisonIndicatorUuidStringobj-123456UUID metrik komposit yang digunakan untuk perbandingan.
comparisonIndicatorCodeStringpay_amt_1dSingkatan untuk nama metrik komposit yang digunakan untuk perbandingan.
comparisonIndicatorNameStringLast day_Payment amountNama tampilan metrik komposit yang digunakan untuk perbandingan.
ownerIdString0001ID pemilik metrik komposit.
ownerNameStringBobNama pemilik metrik komposit.
isDeletedDeleteTagEnumNOMenunjukkan apakah metrik komposit telah dihapus. Nilai yang valid: YES dan NO.
uuidStringobj-123456UUID metrik komposit.
gmtCreateTimeStamp1644397025000Waktu saat metrik komposit dibuat.
gmtModifiedTimeStamp1644459965000Waktu saat metrik komposit terakhir dimodifikasi.
creatorIdString0123456ID pengguna yang membuat metrik komposit.
creatorNameStringA, B, C, and DNama pengguna yang membuat metrik komposit.
modifierIdString0123456ID pengguna yang terakhir memodifikasi metrik komposit.
modifierNameStringA, B, C, and DNama pengguna yang terakhir memodifikasi metrik komposit.

Pernyataan FML yang digunakan untuk melakukan kueri informasi tentang model yang menjadi sandaran sebuah metrik tunggal

show statistic indicator table_code; Parameter respons

ParameterTipeContohDeskripsi
uuidStringobj-123456UUID metrik.
codeStringpay_amtSingkatan untuk nama metrik.
nameStringPayment amountNama tampilan metrik.
extendNameStringpay amountNama metrik.
relationsListContohInformasi tentang model yang menjadi sandaran metrik. Anda dapat melihat kode dan tabel berikut untuk memperoleh struktur parameter EntityInfo.

Contoh struktur dan deskripsi parameter 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"
    }
]
ParameterTipeContohDeskripsi
uuidStringobj-123456UUID model.
codeStringdws_001Singkatan untuk nama model.
nameStringPayment aggregate tableNama tampilan model.
extendNameStringdws_001Nama model.
entityTypeEntityTypeEnumTableTipe entitas metrik. Nilai parameter ini mencakup tetapi tidak terbatas pada TABLE, BASE_ATOMIC_INDICATOR, dan BASE_DERIVATIVE_INDICATOR.
entityTypeNameStringTableNama tipe entitas.
entitySubTypeStringDWS_TABLESubtipe entitas. Nilai parameter ini mencakup tetapi tidak terbatas pada DWS_TABLE, ATOMIC_INDICATOR, dan DERIVATIVE_INDICATOR.
entitySubTypeNameStringAggregate tableNama subtipe entitas.
ownerIdString0001ID pemilik.
ownerNameStringBobNama pemilik.

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 Valid.FML.NoPermission You are not authorized to access the project resources. You are not granted the required permissions to access the current project.
400 Valid.FML.OnlySupportQueryStatement Only FML query statement is supported. Only FML statements are supported.
400 Valid.FML.ProjectNotExist The project does not exist. Information about the project is not found. Check input parameters.
400 Valid.FML.StatementNotValid The FML statement is invalid. The FML statement is invalid. For information about the FML syntax, see https://dataworks-doc.yuque.com/docs/share/ff7899ed-c433-4970-b20e-6582ea3939f3?#.
400 Valid.FML.ProductExpired 智能数据建模产品购买已到期 The Data Modeling feature that you purchase expires.
400 Valid.FML.ProductNotActivated 智能数据建模产品未开通 The Data Modeling feature is not enabled.
500 Execute.FML.ProcessError Failed to execute FML statement. The FML statement fails to be executed. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.