API Daftar Instance
Membaca daftar instance proses dengan filter tanggal dibuat, tanggal selesai, status, dan lainnya
API ini dipakai sistem lain untuk membaca daftar instance proses di satu workspace. Instance yang masih berjalan, selesai, dan dibatalkan bisa diambil, lalu disaring dengan parameter query.
GET /api/v1/report/instancesSiapa yang boleh
Hanya Owner dan Admin SOP workspace. Member ditolak dengan 403.
Header
| Header | Isi |
|---|---|
Authorization | Bearer <access token> |
x-active-tenant | slug workspace |
x-act-env | TEST atau LIVE. Tanpa header ini, yang dibaca LIVE. |
Filter tanggal
Semua tanggal ditulis YYYY-MM-DD, misalnya 2026-10-05. Batasnya inklusif: instance yang dibuat pada tanggal itu ikut.
| Parameter | Menyaring |
|---|---|
start_date | instance yang dibuat pada tanggal ini atau sesudahnya |
end_date | instance yang dibuat pada tanggal ini atau sebelumnya |
completion_start_date | instance yang selesai pada tanggal ini atau sesudahnya |
completion_end_date | instance yang selesai pada tanggal ini atau sebelumnya |
Isi start_date saja untuk mengambil data sejak tanggal tertentu sampai hari ini. Isi keduanya untuk rentang tertutup.
Filter tanggal selesai otomatis membuang instance yang masih berjalan, karena belum punya tanggal selesai.
Contoh
Instance proses pengajuan_cuti yang dibuat mulai 5 Oktober 2026 sampai hari ini:
curl -s 'https://<host>/api/v1/report/instances?proc_def_key=pengajuan_cuti&start_date=2026-10-05&limit=50' \
-H 'Authorization: Bearer <access token>' \
-H 'x-active-tenant: contoh-workspace'Instance yang dibuat sepanjang Oktober 2026 dan sudah selesai:
curl -s 'https://<host>/api/v1/report/instances?start_date=2026-10-01&end_date=2026-10-31&state=COMPLETED' \
-H 'Authorization: Bearer <access token>' \
-H 'x-active-tenant: contoh-workspace'Parameter lain
| Parameter | Bawaan | Keterangan |
|---|---|---|
page | 0 | halaman, mulai dari 0 |
limit | 10 | jumlah per halaman |
state | semua | ACTIVE, COMPLETED, atau CANCELLED |
proc_def_key | key proses, harus sama persis | |
proc_inst_id | id instance, cukup sebagian | |
requestor | nama pembuat, cukup sebagian | |
current_task | nama task yang sedang berjalan, cukup sebagian | |
show_variable | false | true untuk ikut mengembalikan variabel proses |
orderBy | start_time | kolom urutan |
order | desc | asc atau desc |
Variabel proses bisa dipakai sebagai filter dengan pola v_<nama variabel>=<nilai>, misalnya v_status=disetujui.
Filter tanggal yang sama berlaku di GET /api/v1/report/instances/businesskey, yang mengembalikan satu baris per business key.
Jawaban galat
| Kode | Penyebab |
|---|---|
400 | tanggal bukan YYYY-MM-DD, misalnya 05-10-2026, 2026-10-5, atau 2026-02-31 |
400 | start_date jatuh sesudah end_date, atau completion_start_date sesudah completion_end_date |
400 | environment di x-act-env belum ada di workspace |
403 | pemanggil bukan Owner atau Admin SOP |
Contoh pesan 400:
{
"success": false,
"message": "start_date harus berformat YYYY-MM-DD, contoh 2026-10-05",
"data": null
}