Di halaman ini

> sumber daya > dokumentasi > api > Referensi API: Data

Referensi API: Data

warning

Menghapus dataset akan menghapus secara permanen semua datatable dan data terkait. Tindakan ini tidak dapat dibatalkan.

Penggunaan:

# Get the presigned URL with required parameters
URL=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{datatableId}/uploads/presigned-url?datasetid={datasetId}&filename=data.csv&filesize=1024&filelastmodified=1704067200000")

# Upload the file
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"

info

URL presigned hanya berlaku untuk waktu terbatas. Gunakan segera setelah mendapatkannya. Jika unggahan gagal, minta URL presigned baru.

Penggunaan:

# Get the download URL
RESPONSE=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{dataTableId}/download")

# Extract URL and download the file
DOWNLOAD_URL=$(echo $RESPONSE | jq -r '.downloadUrl')
curl -o "data.csv" "$DOWNLOAD_URL"

info

Format file asli datatable yang diunggah tetap dipertahankan (CSV, Parquet, ORC, JSONL, atau Excel). Hasil simulasi selalu dalam format CSV.

Penggunaan:

# Get delta presigned URL
RESPONSE=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url?delta=true&filename=delta.csv&filesize=1024&filelastmodified=1704067200000")

# Upload the delta file
UPLOAD_URL=$(echo $RESPONSE | jq -r '.PreSignedUploadUrl')
curl -X PUT --upload-file "delta.csv" -H "Content-Type: text/csv" "$UPLOAD_URL"

info

Datatable harus sudah memiliki data awal sebelum Anda dapat mengunggah delta. File delta harus menggunakan format yang sama dengan file asli (misalnya, delta CSV untuk file asli CSV, atau delta Parquet untuk file asli Parquet) dan memiliki struktur kolom yang sama. Unggahan delta tidak mendukung file Excel dan XES.

info

Setelah Anda mengunggah file melalui URL presigned, ProcessMind akan memproses delta secara otomatis dan menggabungkannya dengan data asli. Periksa GET /datatables/{dataTableId} hingga hasDataLoaded bernilai true untuk mengetahui kapan pemrosesan selesai.

Dataset adalah kumpulan datatable terkait yang dikelompokkan secara logis.

Daftar dataset

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

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	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 dataset

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

Kesalahan:

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

Buat dataset (dengan datatable kosong)

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

Autentikasi: API key khusus 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": "Dataset"
}

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

Respons (201):

Dataset berhasil dibuat

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

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: `uuid`
treeParentId	string	Ya	Format: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Ya	Nilai yang diizinkan: `Dataset`, `TreeGroup` Default: `Dataset`
displayName	string	Ya	Default: `""` Panjang maksimum: 128
createdAt	string	Ya	Format: `date-time`
updatedAt	string	Ya	Format: `date-time`
dataTableId	string	Ya	Format: `uuid`

Kesalahan:

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

Ambil dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}

Autentikasi: API key khusus tenant · cakupan read

Parameter:

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

Respons (200):

Dataset

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

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: `uuid`
treeParentId	string	Ya	Format: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Ya	Nilai yang diizinkan: `Dataset`, `TreeGroup` Default: `Dataset`
displayName	string	Ya	Default: `""` Panjang maksimum: 128
createdAt	string	Ya	Format: `date-time`
updatedAt	string	Ya	Format: `date-time`
dataTableId	string	Ya	Format: `uuid`

Kesalahan:

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

Hapus dataset secara lunak

Endpoint: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}

Autentikasi: API key khusus tenant · cakupan write

Parameter:

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

Respons (200):

Dataset dihapus

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

Kolom	Tipe	Wajib	Deskripsi
success	boolean	Ya
message	string	Ya

Kesalahan:

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

Daftar datatable dalam dataset

Endpoint: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`
datasetId	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 datatable dalam dataset

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"datasetId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"hasDataLoaded": true,
		"filterExpression": "string",
		"metaInfo": {
			"type": "nodata"
		}
	}
]

Kesalahan:

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

Buat datatable kosong dalam dataset

Endpoint: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Autentikasi: API key khusus tenant · cakupan write

Parameter:

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

Isi permintaan:

{
	"displayName": "string"
}

Kolom	Tipe	Wajib	Deskripsi
displayName	string	Ya	Nama datatable Panjang maksimum: 128

Respons (201):

Datatable berhasil dibuat

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: `uuid`
datasetId	string	Ya	Format: `uuid`
displayName	string	Ya	Default: `""` Panjang maksimum: 128
createdAt	string	Ya	Format: `date-time`
updatedAt	string	Ya	Format: `date-time`
hasDataLoaded	boolean	Ya	Default: `false`
filterExpression	string	Ya	Panjang maksimum: 4096
metaInfo	object \| object \| object \| object	Ya

Kesalahan:

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

Datatable menyimpan data log peristiwa yang digunakan untuk process mining.

Daftar datatable

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

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	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 datatable

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"datasetId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"hasDataLoaded": true,
		"filterExpression": "string",
		"metaInfo": {
			"type": "nodata"
		}
	}
]

Kesalahan:

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

Ambil datatable

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}

Autentikasi: API key khusus tenant · cakupan read

Parameter:

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

Respons (200):

Datatable

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: `uuid`
datasetId	string	Ya	Format: `uuid`
displayName	string	Ya	Default: `""` Panjang maksimum: 128
createdAt	string	Ya	Format: `date-time`
updatedAt	string	Ya	Format: `date-time`
hasDataLoaded	boolean	Ya	Default: `false`
filterExpression	string	Ya	Panjang maksimum: 4096
metaInfo	object \| object \| object \| object	Ya

Kesalahan:

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

Perbarui datatable (displayName, parseSettings, …)

Endpoint: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}

Autentikasi: API key khusus tenant · cakupan write

Parameter:

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

Isi permintaan:

{
	"displayName": "string",
	"filterExpression": "string"
}

Kolom	Tipe	Wajib	Deskripsi
displayName	string	Tidak	Nama datatable Panjang maksimum: 128
filterExpression	string	Tidak	Ekspresi filter yang diterapkan pada data Panjang maksimum: 4096

Respons (200):

Datatable berhasil diperbarui

{
	"id": "00000000-0000-0000-0000-000000000000",
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"hasDataLoaded": true,
	"filterExpression": "string",
	"metaInfo": {
		"type": "nodata"
	}
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: `uuid`
datasetId	string	Ya	Format: `uuid`
displayName	string	Ya	Default: `""` Panjang maksimum: 128
createdAt	string	Ya	Format: `date-time`
updatedAt	string	Ya	Format: `date-time`
hasDataLoaded	boolean	Ya	Default: `false`
filterExpression	string	Ya	Panjang maksimum: 4096
metaInfo	object \| object \| object \| object	Ya

Kesalahan:

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

Dapatkan URL presigned untuk mengunduh file sumber datatable

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download

Autentikasi: API key khusus tenant · cakupan read

Parameter:

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

Respons (200):

URL unduhan

{
	"downloadUrl": "string",
	"expiresInSeconds": 0
}

Kolom	Tipe	Wajib	Deskripsi
downloadUrl	string	Ya
expiresInSeconds	number	Ya

Kesalahan:

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

Batalkan unggahan multipart dan buang bagian yang sudah diunggah

API key harus memiliki cakupan uploadData.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort

Autentikasi: API key khusus tenant · cakupan write

Parameter:

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

Isi permintaan:

{
	"uploadId": "string",
	"uploadHandle": "string"
}

Kolom	Tipe	Wajib	Deskripsi
uploadId	string	Ya
uploadHandle	string	Ya	Handle buram yang dikembalikan pada langkah inisiasi

Respons (200):

Dibatalkan

{
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
message	string	Ya

Kesalahan:

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 mendukung jenis file ini
404 Sumber daya tidak ditemukan

Selesaikan unggahan multipart (langkah 3 dari 3)

API key harus memiliki cakupan uploadData. Bagian yang diunggah akan dirangkai menggunakan ETag-nya, lalu pemrosesan log peristiwa dimulai.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete

Autentikasi: API key khusus tenant · cakupan write

Parameter:

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

Isi permintaan:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"parts": [
		{
			"partNumber": 0,
			"eTag": "string"
		}
	]
}

Kolom	Tipe	Wajib	Deskripsi
uploadId	string	Ya
uploadHandle	string	Ya	Handle buram yang dikembalikan pada langkah inisiasi
parts	object[]	Ya

Respons (200):

Selesai ({ completed: true })

{
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
message	string	Ya

Kesalahan:

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 mendukung jenis file ini
404 Sumber daya tidak ditemukan

Mulai unggahan multipart (berbagi dalam beberapa bagian) untuk data log peristiwa (langkah 1 dari 3)

API key harus memiliki cakupan uploadData. Respons berisi uploadId dan uploadHandle buram untuk digunakan pada panggilan parts, complete, dan abort berikutnya. Cocok untuk file berukuran besar.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate

Autentikasi: API key khusus tenant · cakupan write

Parameter:

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

Isi permintaan:

{
	"fileName": "string",
	"fileSize": 0,
	"fileLastModified": 0,
	"partCount": 0,
	"delta": true,
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
fileName	string	Ya
fileSize	number	Ya
fileLastModified	number	Ya
partCount	number	Tidak	Jumlah bagian yang akan diberi URL presigned (default 10)
delta	boolean	Tidak	Menentukan apakah ini unggahan delta (inkremental)
datasetId	string	Tidak	Format: `uuid`
modelId	string	Tidak	Format: `uuid`

Respons (200):

Unggahan dimulai

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partCount": 0,
	"partSizeBytes": 0
}

Kolom	Tipe	Wajib	Deskripsi
uploadId	string	Tidak
uploadHandle	string	Tidak	Handle buram untuk langkah parts/complete/abort
partCount	number	Tidak
partSizeBytes	number	Tidak

Kesalahan:

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 mendukung jenis file ini
404 Sumber daya tidak ditemukan

Dapatkan URL presigned untuk bagian unggahan multipart (langkah 2 dari 3)

API key harus memiliki cakupan uploadData. Respons berisi satu URL PUT presigned untuk setiap nomor bagian yang diminta.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts

Autentikasi: API key khusus tenant · cakupan write

Parameter:

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

Isi permintaan:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partNumbers": [
		0
	]
}

Kolom	Tipe	Wajib	Deskripsi
uploadId	string	Ya
uploadHandle	string	Ya	Handle buram yang dikembalikan pada langkah inisiasi
partNumbers	number[]	Ya

Respons (200):

URL presigned untuk bagian ({ uploadId, parts: [{ partNumber, url }] })

{
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
message	string	Ya

Kesalahan:

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 mendukung jenis file ini
404 Sumber daya tidak ditemukan

Dapatkan URL unggah S3 presigned untuk data log peristiwa (CSV/XLSX, penuh atau delta)

API key harus memiliki cakupan uploadData, terlepas dari cakupan read/write. Nilai filesize yang dinyatakan (dalam byte) akan diperiksa terhadap batas maksimum ukuran unggahan platform. Ukuran file sebenarnya akan diperiksa kembali setelah file diterima.

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`
dataTableId	string	path	Ya	Format: `uuid`
filename	string	query	Ya
filesize	string	query	Ya	Ukuran file dalam byte (diperiksa terhadap batas maksimum ukuran unggahan platform)
filelastmodified	string	query	Ya
datasetid	string	query	Tidak	Wajib untuk unggahan penuh (bukan delta)
modelid	string	query	Tidak	Format: `uuid`
delta	`true` \| `false`	query	Tidak	Nilai yang diizinkan: `true`, `false`
partnumber	string	query	Tidak
validforseconds	integer	query	Tidak	Masa berlaku URL presigned dalam detik (1–3600, default 3600)

Respons (200):

URL presigned

{
	"PreSignedUploadUrl": "string"
}

Kolom	Tipe	Wajib	Deskripsi
PreSignedUploadUrl	string	Ya	URL PUT S3 presigned (berlaku sekitar 1 jam)

Kesalahan:

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 mendukung jenis file ini
404 Sumber daya tidak ditemukan
413 Ukuran file melebihi batas maksimum unggahan platform

Dokumentasi terkait

Referensi API: Organisasi

Referensi API untuk endpoint pengelolaan organisasi dan administrasi pengguna.

Referensi API: Tenant

Referensi API untuk endpoint pengelolaan tenant dan kontrol akses pengguna.

Referensi API: Proses

Referensi API untuk endpoint pengelolaan proses dan pemetaan data.

Referensi API: Simulasi

Referensi API untuk pengelolaan simulasi dan endpoint pembuatan berbantuan AI.

Rancang proses yang lebih baik. Bangun arsitektur yang saling terhubung. Tetap kendalikan semuanya.

Mulai sekarang juga tanpa kartu kredit dan tanpa perlu menunggu. Ubah cara kerja organisasi Anda menjadi rancangan proses yang jelas dan saling terhubung.

Bangun arsitektur proses, tetapkan penanggung jawab dan kontrol, lalu selaraskan peran serta tanggung jawab di setiap tingkat.

Mulai uji coba gratis dan bangun satu landasan tepercaya untuk mengatur, mengelola, dan terus memperbaiki proses Anda.

Mulai uji coba gratis hari ini