Katalog Action
Referensi lengkap semua action API yang tersedia di RESTForge Server
Halaman ini berisi daftar lengkap semua action API yang tersedia di RESTForge, dikelompokkan berdasarkan kategori. Setiap action memiliki halaman spesifikasi tersendiri dengan detail parameter, format request/response, dan contoh penggunaan.
Referensi Cepat (Quick Reference)
| Properti | Nilai |
|---|---|
| Pola URL | POST /api/{project}/{endpoint}/{action} |
| Total Kategori | 6 kategori action tersedia |
| Database | PostgreSQL, MySQL, Oracle |
| Konfigurasi | Action diaktifkan melalui property action di file payload |
CRUD Standar (Standard CRUD)
Action dasar untuk operasi data pada entitas tunggal.
| Action | Method | Fungsi | Halaman |
|---|---|---|---|
create | POST | Membuat satu record baru | POST /create |
read | POST | Mengambil data dengan pagination dan filter | POST /read |
first | POST | Mengambil satu record berdasarkan kondisi | POST /first |
update | POST | Memperbarui satu record berdasarkan primary key | POST /update |
delete | POST | Menghapus satu record berdasarkan kondisi WHERE | POST /delete |
adjust | POST | Atomic increment/decrement field numerik | POST /adjust |
Action CRUD standar diaktifkan melalui property action di payload:
{
"action": {
"create": true,
"read": true,
"first": true,
"update": true,
"delete": true
}
}Query & Pengambilan Data (Query & Retrieval)
Action untuk pengambilan data dengan format dan keperluan yang berbeda.
| Action | Method | Fungsi | Halaman |
|---|---|---|---|
datatables | POST | Server-side processing untuk DataTables.net | POST /datatables |
lookup | GET / POST | Data untuk dropdown dan autocomplete | POST /lookup |
aggregate | POST | Fungsi agregasi (COUNT, SUM, AVG, MIN, MAX, GROUP BY) | POST /aggregate |
Endpoint /lookup mendukung dua HTTP method: GET dengan header X-Request-Mode: dynamic untuk pencarian real-time, dan POST dengan header X-Request-Mode: static untuk memuat seluruh data dropdown.
Operasi Composite (Composite Operations)
Action untuk operasi master-detail (header + detail items) dalam satu transaksi atomik.
| Action | Method | Fungsi | Halaman |
|---|---|---|---|
create-composite | POST | Membuat header beserta detail items | POST /create-composite |
read-composite | POST | Mengambil header beserta detail items | POST /read-composite |
update-composite | POST | Memperbarui header + insert/update/delete detail | POST /update-composite |
Action composite memerlukan konfigurasi masterDetail di payload.
Workflow
Action untuk perubahan status record dengan validasi transisi dan hook.
| Action | Method | Fungsi | Halaman |
|---|---|---|---|
change-status | POST | Perubahan status dengan validasi transisi dan hook API call | POST /change-status |
Endpoint /change-status saat ini hanya tersedia untuk PostgreSQL. Memerlukan konfigurasi workflow di payload.
Export dan Import
Action untuk transfer data antara RESTForge dan file Excel. Proses berjalan secara asinkron menggunakan job queue.
| Action | Method | Fungsi | Halaman |
|---|---|---|---|
export | POST | Trigger async export ke Excel | POST /export |
export-status | GET | Polling status export job | POST /export |
export-download | GET | Download file Excel hasil export | POST /export |
import-upload | POST | Upload file Excel (multipart/form-data) | POST /import |
import-preview | POST | Validasi dan preview data import | POST /import |
import-commit | POST | Eksekusi INSERT/UPDATE ke database | POST /import |
import-status | GET | Polling status import job | POST /import |
Resource Lock
Action untuk mengunci record dan mencegah concurrent editing.
| Action | Method | Fungsi |
|---|---|---|
lock/acquire | POST | Mengunci satu atau lebih record |
lock/release | POST | Melepas kunci record |
lock/status | POST | Mengecek status kunci record |
Fitur yang Direncanakan (Planned Features)
Action berikut sedang dalam pengembangan dan belum tersedia:
| Kategori | Action | Fungsi |
|---|---|---|
| Bulk Operations | bulk-create, bulk-update, bulk-delete | Operasi batch pada banyak record sekaligus |
| Validation | validate, check-duplicate, check-availability | Validasi data tanpa menyimpan |
| Relationship | attach, detach, sync | Manajemen relasi many-to-many |
| Utility | clone, history, print | Operasi utilitas umum |
Fitur yang direncanakan dapat berubah. Dokumentasi akan diperbarui saat fitur tersedia.
Langkah Selanjutnya (Next Steps)
- Pola URL untuk memahami pola URL dan konvensi penamaan
- Kode Error untuk referensi HTTP status code dan format error
- POST /create untuk memulai dari endpoint paling dasar