API ini dipakai sistem lain untuk membaca instance proses yang masih berjalan di satu workspace, lengkap dengan variabelnya. Environment-nya dipilih sendiri: TEST atau LIVE. Instance yang sudah selesai atau dibatalkan tidak ikut.

Ada dua cara memakainya:

• REST: GET /api/v1/report/instances/active, untuk sistem yang memanggil API langsung.
• MCP: tool list_active_instances, untuk agen AI yang tersambung ke MCP server AlurKerja.

Siapa yang boleh

Hanya Owner dan Admin SOP workspace. Member ditolak.

Menyalakan fitur

Fitur ini mati secara bawaan. Admin instalasi menyalakannya di berkas .env server:

FEATURE_FLAG_ACTIVE_INSTANCES_API=true

Lalu jalankan ulang dua servis yang membacanya:

docker compose up -d onprem-report onprem-integration

Selama flag mati, REST menjawab 404 dan tool MCP tidak muncul.

Memanggil lewat REST

Kirim tiga header:

Parameter query:

Contoh:

curl -s 'https://<host>/api/v1/report/instances/active?limit=20&variables=jumlah_hari,status' \
  -H 'Authorization: Bearer <access token>' \
  -H 'x-active-tenant: contoh-workspace' \
  -H 'x-act-env: TEST'

Contoh jawaban (dipersingkat):

{
  "success": true,
  "environment": "TEST",
  "data": {
    "data": [
      {
        "proc_inst_id": "1234567",
        "process_name": "Pengajuan Cuti",
        "proc_def_key": "pengajuan_cuti",
        "business_key": "CUTI-0001",
        "state": "ACTIVE",
        "start_time": "2026-10-12T09:00:00Z",
        "current_tasks": [
          { "current_task": "Persetujuan Atasan", "type": "userTask", "assignee": "Budi", "assignee_email": "budi@contoh.id" }
        ],
        "variables": {
          "jumlah_hari": { "type": "long", "value": 3 },
          "status": { "type": "string", "value": "menunggu" }
        }
      }
    ],
    "page": 0,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}

Jawaban galat:

Memanggil lewat MCP

Buat token MCP dari avatar (kanan atas) → MCP Connection, lalu sambungkan agen ke MCP server AlurKerja. Agen memakai tool list_active_instances dengan argumen:

Contoh perintah ke agen: "Tampilkan pengajuan cuti yang masih berjalan di environment TEST beserta jumlah hari dan statusnya."

Batasan nilai variabel

• Variabel file hanya berisi nama dan ukuran berkas, tanpa isinya.
• Teks lebih dari 4000 karakter tetap dikembalikan utuh.
• Variabel objek Java (serializable) hanya berisi nama kelasnya, misalnya java.util.HashMap.