Referensi API: Proses

Endpoint ini digunakan di ruang kerja Anda sendiri. Mulai uji coba gratis untuk membuat ruang kerja dan melakukan panggilan API pertama.

Tampilkan daftar proses

Endpoint: GET /v1/tenant/{tenantId}/processes

Autentikasi: API key bercakupan tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
limit	integer	query	Tidak	Jumlah maksimum item yang ditampilkan
offset	integer	query	Tidak	Jumlah item yang dilewati

Respons (200):

Daftar proses

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Process",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"designerModelId": "00000000-0000-0000-0000-000000000000"
	}
]

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa

Buat proses (dengan model kosong)

Endpoint: POST /v1/tenant/{tenantId}/processes

Autentikasi: API key bercakupan tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}

Kolom	Jenis	Wajib	Deskripsi
displayName	string	Ya	Nama proses yang ditampilkan di pohon proses Panjang maksimum: 128
treeParentId	string	Tidak	ID folder induk (null = tingkat teratas) Format: uuid
treeNodeType	Process | TreeGroup	Tidak	Proses atau TreeGroup (folder) Nilai yang diizinkan: Process, TreeGroup Default: Process

Respons (201):

Proses dibuat

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: uuid
treeParentId	string	Ya	Format: uuid
treeNodeType	Process | TreeGroup	Ya	Nilai yang diizinkan: Process, TreeGroup Default: Process
displayName	string	Ya	Default: New Process Panjang maksimum: 128
createdAt	string	Ya	Format: date-time
updatedAt	string	Ya	Format: date-time
designerModelId	string	Ya	Format: uuid

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 500 Terjadi error server yang tidak terduga. Permintaan aman untuk dicoba kembali.

Dapatkan detail proses

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}

Autentikasi: API key bercakupan tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Respons (200):

Proses

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: uuid
treeParentId	string	Ya	Format: uuid
treeNodeType	Process | TreeGroup	Ya	Nilai yang diizinkan: Process, TreeGroup Default: Process
displayName	string	Ya	Default: New Process Panjang maksimum: 128
createdAt	string	Ya	Format: date-time
updatedAt	string	Ya	Format: date-time
designerModelId	string	Ya	Format: uuid

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404 Sumber daya tidak ditemukan

Perbarui proses

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}

Autentikasi: API key bercakupan tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
displayName	string	Tidak	Nama proses yang ditampilkan di pohon proses Panjang maksimum: 128
treeParentId	string	Tidak	ID folder induk (null = tingkat teratas) Format: uuid

Respons (200):

Proses diperbarui

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: uuid
treeParentId	string	Ya	Format: uuid
treeNodeType	Process | TreeGroup	Ya	Nilai yang diizinkan: Process, TreeGroup Default: Process
displayName	string	Ya	Default: New Process Panjang maksimum: 128
createdAt	string	Ya	Format: date-time
updatedAt	string	Ya	Format: date-time
designerModelId	string	Ya	Format: uuid

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404 Sumber daya tidak ditemukan
• 500 Terjadi error server yang tidak terduga. Permintaan aman untuk dicoba kembali.

Hapus sementara proses

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}

Autentikasi: API key bercakupan tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Respons (200):

Proses dihapus

{
	"success": true,
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
success	boolean	Ya
message	string	Ya

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404 Sumber daya tidak ditemukan

Ekspor model proses sebagai XML BPMN 2.0

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

Autentikasi: API key bercakupan tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Respons (200):

XML BPMN

{
	"bpmnXml": "string"
}

Kolom	Tipe	Wajib	Deskripsi
bpmnXml	string	Ya	XML BPMN 2.0

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 403 API key tidak memiliki cakupan atau akses organisasi yang diperlukan, tenant tidak aktif, atau paket tidak mengizinkan jenis file tersebut
• 404 Sumber daya tidak ditemukan
• 500 Terjadi error server yang tidak terduga. Permintaan aman untuk dicoba kembali.

Impor model BPMN 2.0 untuk proses (menggantikan model saat ini)

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Autentikasi: API key bercakupan tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"bpmnXml": "string"
}

Kolom	Tipe	Wajib	Deskripsi
bpmnXml	string	Ya	XML BPMN 2.0

Respons (200):

BPMN berhasil diunggah

{
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
message	string	Ya

Error:

• 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan tidak didukung, atau kolom wajib tidak diisi
• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404 Sumber daya tidak ditemukan

Pemetaan data menghubungkan tabel data ke proses, sehingga Anda dapat melihat dan menganalisis data log peristiwa pada model proses.

Tampilkan pemetaan data untuk proses

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

Autentikasi: API key bercakupan tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
limit	integer	query	Tidak	Jumlah maksimum item yang ditampilkan
offset	integer	query	Tidak	Jumlah item yang dilewati

Respons (200):

Daftar pemetaan

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

Kesalahan:

• 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Petakan datatable ke proses (pemrosesan log peristiwa dimulai)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/mappings

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}

Kolom	Tipe	Wajib	Deskripsi
dataTableId	string	Ya	Datatable yang akan dipetakan ke proses Format: uuid
displayName	string	Tidak	Nama tampilan pemetaan Panjang maksimum: 128
color	object	Tidak	Warna aksen
showByDefault	boolean	Tidak	Tampilkan pemetaan ini secara default di tampilan proses Default: true
mappingRole	primary | comparison	Tidak	Peran data yang dipetakan dalam model Nilai yang diizinkan: primary, comparison

Respons (201):

Pemetaan dibuat

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: uuid
modelId	string	Ya	Format: uuid
dataTableId	string	Ya	Format: uuid
displayName	string	Ya	Panjang maksimum: 128
color	object	Ya
showByDefault	boolean	Ya	Default: true
mappingRole	primary | comparison	Ya	Nilai yang diizinkan: primary, comparison Default: comparison
sortOrder	integer	Ya	Default: 0 Minimum: -9007199254740991 Maksimum: 9007199254740991

Kesalahan:

• 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 403API key tidak memiliki cakupan atau akses organisasi yang diperlukan, tenant tidak aktif, atau paket tidak mengizinkan jenis file ini
• 404Sumber daya tidak ditemukan

Perbarui pemetaan

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
mappingId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Kolom	Tipe	Wajib	Deskripsi
displayName	string	Tidak	Panjang maksimum: 128
color	object	Tidak
showByDefault	boolean	Tidak
mappingRole	primary | comparison	Tidak	Nilai yang diizinkan: primary, comparison
sortOrder	integer	Tidak	Minimum: -9007199254740991 Maksimum: 9007199254740991

Respons (200):

Pemetaan diperbarui

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: uuid
modelId	string	Ya	Format: uuid
dataTableId	string	Ya	Format: uuid
displayName	string	Ya	Panjang maksimum: 128
color	object	Ya
showByDefault	boolean	Ya	Default: true
mappingRole	primary | comparison	Ya	Nilai yang diizinkan: primary, comparison Default: comparison
sortOrder	integer	Ya	Default: 0 Minimum: -9007199254740991 Maksimum: 9007199254740991

Kesalahan:

• 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Hapus pemetaan

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
mappingId	string	path	Ya	Format: uuid

Respons (200):

Pemetaan dihapus

{
	"success": true,
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
success	boolean	Ya
message	string	Ya

Kesalahan:

• 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Endpoint ini menggunakan AI untuk membuat model proses BPMN secara otomatis dari deskripsi dalam bahasa sehari-hari.

Buat model proses dari prompt bahasa alami (asinkron; periksa status melalui endpoint status)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Autentikasi: API key khusus tenant · cakupan write · batas laju 2 permintaan/detik (maksimal 4 sekaligus)

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"prompt": "string"
}

Kolom	Tipe	Wajib	Deskripsi
prompt	string	Ya

Respons (200):

Pembuatan dimulai / hasil

{
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
message	string	Ya

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Periksa status pembuatan model

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Respons (200):

Status pembuatan

{
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
message	string	Ya

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Metrik per kasus dari model proses terbaru: satu baris untuk setiap kasus, berisi urutan dan metrik kesehatan yang dihitung.

Ambil metrik per kasus untuk proses (model terbaru, berpaginasi)

Mengembalikan satu baris untuk setiap kasus, berisi metrik proses yang dihitung (durasi kasus, panjang, kesesuaian, pengerjaan ulang, skor kesehatan, varian, dan lainnya) dari model proses terbaru. Tidak ada pemfilteran baris. Hasil dibagi ke beberapa halaman: gunakan limit (default 1.000, maksimum 10.000) dan offset, lalu lanjutkan ke halaman berikutnya selama hasMore bernilai true. Selama metrik masih dihitung, respons memiliki status preprocessing.

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
limit	integer	query	Tidak	Jumlah maksimum baris kasus yang dikembalikan (default 1.000, maksimum 10.000)
offset	integer	query	Tidak	Jumlah baris kasus yang dilewati (default 0)

Respons (200):

Metrik kasus

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

Kesalahan:

• 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan
• 503Pipeline data belum siap atau kueri ke sistem hulu gagal

Daftar versi proses

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
limit	integer	query	Tidak	Jumlah maksimum item yang dikembalikan
offset	integer	query	Tidak	Jumlah item yang dilewati

Respons (200):

Daftar versi

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Buat rekam versi proses

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/versions

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
displayName	string	Tidak	Label versi Default: "" Panjang maksimum: 128
description	string	Tidak	Deskripsi opsional versi
versionType	manual | auto	Tidak	manual = dibuat pengguna, auto = dibuat sistem Nilai yang diizinkan: manual, auto
restoreFromVersionId	string	Tidak	Versi yang digunakan untuk memulihkan saat membuat rekam ini Format: uuid

Respons (201):

Versi dibuat

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Kolom	Tipe	Wajib	Deskripsi
version	object	Ya
restoredFrom	object	Ya

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Ambil versi proses

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
versionId	string	path	Ya	Format: uuid

Respons (200):

Versi

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Kolom	Tipe	Wajib	Deskripsi
version	object	Ya

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Ganti nama atau perbarui versi proses

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
versionId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"displayName": "string",
	"description": "string"
}

Kolom	Tipe	Wajib	Deskripsi
displayName	string	Tidak	Label versi Panjang maksimum: 128
description	string	Tidak	Deskripsi opsional versi

Respons (200):

Versi diperbarui

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Kolom	Tipe	Wajib	Deskripsi
version	object	Ya

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Hapus versi proses

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
versionId	string	path	Ya	Format: uuid

Respons (200):

Versi dihapus

{
	"deleted": true
}

Kolom	Tipe	Wajib	Deskripsi
deleted	boolean	Ya

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Ambil artefak

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
artifactId	string	path	Ya	Format: uuid

Respons (200):

Artefak

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: uuid
displayName	string	Ya	Default: "" Panjang maksimum: 500
description	string	Ya	Panjang maksimum: 2.000
originalFileName	string	Ya	Default: "" Panjang maksimum: 500
mimeType	string	Ya	Default: "" Panjang maksimum: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Ya	Nilai yang diizinkan: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Ya	Nilai yang diizinkan: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Default: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Ya	Nilai yang diizinkan: Uploading, Ready, Failed, Deleted Default: Uploading
hasThumbnail	boolean	Ya	Default: false
sizeBytes	number	Ya	Default: 0
createdAt	string	Ya	Format: date-time
createdBy	string	Tidak	Format: uuid

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Perbarui nama tampilan atau deskripsi artefak

Endpoint: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
artifactId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"displayName": "string",
	"description": "string"
}

Kolom	Tipe	Wajib	Deskripsi
displayName	string	Tidak	Nama artefak Panjang maksimum: 500
description	string	Tidak	Deskripsi opsional artefak Panjang maksimum: 2.000

Respons (200):

Artefak diperbarui

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: uuid
displayName	string	Ya	Default: "" Panjang maksimum: 500
description	string	Ya	Panjang maksimum: 2.000
originalFileName	string	Ya	Default: "" Panjang maksimum: 500
mimeType	string	Ya	Default: "" Panjang maksimum: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Ya	Nilai yang diizinkan: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Ya	Nilai yang diizinkan: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Default: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Ya	Nilai yang diizinkan: Uploading, Ready, Failed, Deleted Default: Uploading
hasThumbnail	boolean	Ya	Default: false
sizeBytes	number	Ya	Default: 0
createdAt	string	Ya	Format: date-time
createdBy	string	Tidak	Format: uuid

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Hapus artefak

Endpoint: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
artifactId	string	path	Ya	Format: uuid

Respons (200):

Artefak dihapus

{
	"deleted": true
}

Kolom	Tipe	Wajib	Deskripsi
deleted	boolean	Ya

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Alihkan ke URL bertanda tangan untuk mengunduh artefak

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
artifactId	string	path	Ya	Format: uuid

Kesalahan:

• 302Alihkan ke URL unduhan bertanda tangan
• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Daftar artefak yang dilampirkan ke proses

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid
limit	integer	query	Tidak	Jumlah maksimum item yang dikembalikan
offset	integer	query	Tidak	Jumlah item yang dilewati

Respons (200):

Daftar artefak proses

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

Kesalahan:

• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404Sumber daya tidak ditemukan

Dapatkan URL unggahan S3 bertanda tangan untuk artefak proses baru

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
processId	string	path	Ya	Format: uuid

Isi permintaan:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}

Kolom	Tipe	Wajib	Deskripsi
fileName	string	Ya
mimeType	string	Ya
sizeBytes	number	Ya
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	Tidak	Nilai yang diizinkan: modelIcon, processArtifact, doc, levelFrontPageImage Default: processArtifact

Respons (200):

URL unggahan bertanda tangan

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}

Kolom	Tipe	Wajib	Deskripsi
artifactId	string	Ya	Format: uuid
originalUrl	string	Ya
thumbnailUrl	string	Ya

Kesalahan:

• 400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
• 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 403API key tidak memiliki cakupan atau akses organisasi yang diperlukan, tenant tidak aktif, atau paket tidak mengizinkan jenis file ini
• 404Sumber daya tidak ditemukan
• 409Permintaan bertentangan dengan status saat ini (misalnya, batas lisensi atau ID yang digunakan kembali)