All Products
Search

This Product

    DataWorks:DataService Studio API

    Document Center

    DataWorks:DataService Studio API

    Last Updated:Jul 25, 2026

    Data Map memungkinkan Anda menemukan API DataService Studio di seluruh ruang kerja dalam penyewa saat ini, sehingga mempermudah proses penemuan.

    Halaman pencarian API

    1. Buka halaman Data Map.

      Masuk ke Konsol DataWorks. Di Wilayah target, klik Data Governance > Data Map di panel navigasi sebelah kiri. Pada halaman yang muncul, klik Go to Data Map.

    2. Di atas kotak pencarian, pilih kategori API.

      Menu drop-down tipe pencarian di sisi kiri bilah pencarian berisi tiga kelompok: Code, API, dan Dataset. Pilih API dalam kelompok API.

    Temukan API

    1. Pada kotak pencarian di bawah kategori API, masukkan kata kunci seperti API ID, APIPath, API Name, atau API Description.

      Saat Anda mengetik kata kunci, daftar drop-down akan menampilkan 10 API teratas yang sesuai.

    2. Jika API yang Anda cari tidak muncul dalam daftar drop-down, klik Search untuk melihat semua hasil yang cocok.

    3. Di panel sebelah kiri, Anda dapat memfilter hasil pencarian berdasarkan API Type, Workspace, atau Owner.

    4. Setelah menemukan API yang dituju, Anda dapat mengkliknya untuk membuka halaman detail. Untuk informasi lebih lanjut, lihat View API details.

    Detail API

    Halaman detail API menyediakan informasi Basic Information, Technical Information, Parameter Information, Sample Response, dan Instructions. Jika API tersebut merupakan Script Mode, tab tambahan Code juga akan ditampilkan.

    Halaman detail API dibagi menjadi tiga area: Area ① di bagian atas menampilkan nama API, deskripsi, dan titik masuk untuk mengedit API. Area ② di panel kiri menunjukkan informasi dasar dan teknis API. Area ③ di panel kanan menggunakan tab untuk menampilkan konten detail seperti informasi parameter, contoh respons, informasi alur data, dan catatan penggunaan. Tabel berikut menjelaskan setiap area.

    Area

    Description

    ①

    Klik Edit API untuk membuka jendela pengeditan di ruang kerja API tersebut. Untuk informasi lebih lanjut, lihat API testing, publishing, and version management dan Register an external API service.

    Catatan

    Jika akun Anda bukan anggota ruang kerja API tersebut, hubungi Pemilik ruang kerja dan minta agar akun Anda ditambahkan sebagai anggota dengan role Developer. Untuk informasi lebih lanjut, lihat Manage permissions on workspace-level services.

    ②

    Area ini menampilkan informasi API berikut:

    • Basic Information: Meliputi detail seperti Views, Number of Calls, API ID, Workspace, Owner, Created At, Last Updated, dan Description.

    • Technical Information: Meliputi detail seperti API Type, Request Method, Response Type, Data Source Type, Data Source Name, dan Table Name.

    ③

    Area ini menampilkan informasi API berikut:

    • Parameter Information: Menampilkan Request Parameters dan Response Parameters dari API.

      • Request Parameters: Meliputi detail untuk Common Request Parameters dan API Request Parameters, termasuk Parameter Name, Parameter Type, Parameter Position, Sample Value, Default Value, Description, dan Label.

      • Response Parameters: Meliputi detail untuk Common Response Parameters dan API Response Parameters, termasuk Parameter Name, Parameter Type, Sample Value, dan Description.

    • Sample Response: Sebelum menerbitkan API, jika Anda mengujinya dan memilih Save the correct response example automatically selama pengujian, contoh respons akan diperbarui berdasarkan hasil pengujian. Untuk informasi lebih lanjut, lihat Test an API. Konten dan struktur pada Sample Response menunjukkan format respons API.

    • Lineage Information: Menampilkan alur data lengkap antara tabel data, API, dan aplikasi. Alur data hulu untuk API DataService Studio mendukung jenis sumber data berikut: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0, dan AnalyticDB for PostgreSQL.

      Catatan

      • API Generation dibuat dengan mengenkapsulasi sumber data atau tabel. Oleh karena itu, alur datanya mencakup tabel data, API, dan aplikasi.

      • Register API dibuat dengan mengenkapsulasi alamat backend. Oleh karena itu, alur datanya hanya mencakup API dan aplikasi.

      • Alur data dihasilkan dan diperbarui secara T+1.

    • Instructions: Anda dapat Edit catatan atau View Versions untuk meninjau perubahan historis.

    • Code: Tab ini hanya muncul jika API berupa Script Mode. Tab ini memungkinkan Anda melihat kode kueri kustom (seperti SQL) yang ditulis oleh developer. Tab ini tidak ditampilkan untuk jenis API lainnya (API mode wizard, API terdaftar, atau API layanan terorchestrasi); untuk API mode wizard, Anda dapat meninjau SQL-nya di editor pengembangan API DataService.

      Catatan

      Jika Anda menemukan API mode skrip dengan mencari potongan kode di kotak pencarian global Data Map, sistem akan langsung mengarahkan Anda ke tab Code.