Doküman Listesi

Bu Sayfada

> kaynaklar > dokumanlar > api > API Referansı: Data

API Referansı: Data

Dataset Uç Noktaları

Datasetler, ilişkili datatable’ların mantıksal olarak bir araya getirildiği koleksiyonlardır.

Datasetleri Listele

Tenant içindeki tüm datasetleri görüntüleyin.

Endpoint: GET /tenant/{tenantId}/datasets

Parametreler:

Name	Type	Location	Required	Açıklama
tenantId	string	path	Evet	Tenant’ın benzersiz kimliği

Response:

[
	{
		"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
		"displayName": "Satış Verisi",
		"createdAt": "2024-01-20T08:00:00Z",
		"datatableCount": 3
	}
]

Dataset Oluştur

Bir tenant içinde yeni bir dataset oluşturun.

Endpoint: POST /tenant/{tenantId}/datasets

Parametreler:

Name	Type	Location	Required	Açıklama
tenantId	string	path	Evet	Tenant’ın benzersiz kimliği

Request Body:

{
	"displayName": "Yeni Datasetim",
	"treeNodeType": "Dataset",
	"treeParentId": null
}

Alan	Tip	Zorunlu	Açıklama
displayName	string	Evet	Dataset adı
treeNodeType	string	Hayır	Varsayılan `Dataset` veya `TreeGroup` olmalı
treeParentId	string	Hayır	Datasetleri gruplamak için ana klasör ID’si

Response: Oluşturulan dataset objesini döndürür.

Dataset Bilgilerini Getir

Belirli bir dataset hakkında detayları görüntüleyin.

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

Parametreler:

Name	Type	Location	Required	Açıklama
tenantId	string	path	Evet	Tenant’ın benzersiz kimliği
datasetId	string	path	Evet	Dataset’in benzersiz kimliği

Response:

{
	"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
	"displayName": "Satış Verisi",
	"createdAt": "2024-01-20T08:00:00Z",
	"datatables": [
		{
			"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
			"displayName": "Orders",
			"rowCount": 15000
		}
	]
}

Dataset Sil

Bir dataset ve tüm datatable’larını silin.

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

Parametreler:

Name	Type	Location	Required	Açıklama
tenantId	string	path	Evet	Tenant’ın benzersiz kimliği
datasetId	string	path	Evet	Dataset’in benzersiz kimliği

Response:

{
	"success": true
}

warning

Bir dataset silindiğinde, bağlantılı tüm datatable ve veriler kalıcı olarak silinir. Bu işlem geri alınamaz.

Datatable Uç Noktaları

Datatable’lar, Process Mining için kullanılan gerçek event log data’larını saklar.

Datatable’ları Listele

Tenant içindeki tüm datatable’ları görüntüleyin.

Endpoint: GET /tenant/{tenantId}/datatables

Parametreler:

Name	Type	Location	Required	Açıklama
tenantId	string	path	Evet	Tenant’ın benzersiz kimliği

Response:

[
	{
		"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Orders 2024",
		"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
		"rowCount": 15000,
		"createdAt": "2024-01-25T10:00:00Z"
	}
]

Datatable Oluştur

Mevcut bir dataset içinde yeni bir datatable oluşturun.

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

Parametreler:

Name	Type	Location	Required	Açıklama
tenantId	string	path	Evet	Tenant’ın benzersiz kimliği
datasetId	string	path	Evet	Dataset’in benzersiz kimliği

Request Body:

{
	"displayName": "Orders Q1 2024"
}

Alan	Tip	Zorunlu	Açıklama
displayName	string	Evet	Datatable adı

Response: Oluşturulan datatable objesini döndürür.

Datatable Bilgilerini Getir

Belirli bir datatable hakkında detaylara erişin.

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}

Parametreler:

Name	Type	Location	Required	Açıklama
tenantId	string	path	Evet	Tenant’ın benzersiz kimliği
datatableId	string	path	Evet	Datatable’ın benzersiz kimliği

Response:

{
	"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Orders 2024",
	"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
	"rowCount": 15000,
	"columns": [
		{"name": "case_id", "type": "string"},
		{"name": "activity", "type": "string"},
		{"name": "timestamp", "type": "datetime"}
	],
	"createdAt": "2024-01-25T10:00:00Z"
}

Presigned Yükleme URL’si Al

Bir dosyayı doğrudan bir datatable’a yüklemek için geçici bir URL alın.

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl

Parametreler:

Name	Type	Location	Required	Açıklama
tenantId	string	path	Evet	Tenant’ın benzersiz kimliği
datatableId	string	path	Evet	Datatable’ın benzersiz kimliği
datasetid	string	query	Evet	Dataset’in benzersiz kimliği
filename	string	query	Evet	Yüklenecek dosyanın adı
filesize	string	query	Evet	Dosya boyutu (byte)
filelastmodified	string	query	Evet	Dosyanın son değişiklik tarihi timestamp
validforseconds	string	query	Hayır	URL’nin geçerlilik süresi (saniye olarak, varsayılan: 3600)

Response:

{
	"PreSignedUploadUrl": "https://s3.amazonaws.com/bucket/path?X-Amz-Algorithm=AWS4-HMAC-SHA256&..."
}

Kullanım: Dönen URL ile dosyanızı HTTP PUT ile yükleyebilirsiniz:

# Gerekli parametrelerle presigned URL alınır
URL=$(curl -s -H "X-API-Key: your-api-key" \
  "https://api.processmind.com/tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl?datasetid={datasetId}&filename=data.csv&filesize=1024&filelastmodified=1704067200000")

# Dosyayı yükleyin
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"

info

Presigned URL’ler kısa süre geçerli olur. URL’yi aldıktan sonra hemen kullanın. Yükleme başarısız olursa yeni bir presigned URL alın.