API Referansı: Organizasyon Yönetimi
Organizasyon ve kullanıcı yönetimi API referans dokümantasyonu.
Datasetler, ilişkili datatable’ların mantıksal olarak bir araya getirildiği koleksiyonlardır.
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 |
Yanıt:
[
{
"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"displayName": "Sales Data",
"createdAt": "2024-01-20T08:00:00Z",
"datatableCount": 3
}
] 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 |
İstek Gövdesi:
{
"displayName": "My New Dataset",
"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 |
Yanıt: Oluşturulan dataset objesini döndürür.
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 |
Yanıt:
{
"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"displayName": "Sales Data",
"createdAt": "2024-01-20T08:00:00Z",
"datatables": [
{
"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
"displayName": "Orders",
"rowCount": 15000
}
]
} 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 |
Yanıt:
{
"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’lar, Process Mining için kullanılan gerçek event log data’larını saklar.
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 |
Yanıt:
[
{
"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
"displayName": "Orders 2024",
"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"rowCount": 15000,
"createdAt": "2024-01-25T10:00:00Z"
}
] 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 |
İstek Gövdesi:
{
"displayName": "Orders Q1 2024"
} | Alan | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| displayName | string | Evet | Datatable adı |
Yanıt: Oluşturulan datatable objesini döndürür.
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 |
Yanıt:
{
"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"
} 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 zaman damgası (zaman damgası) |
| validforseconds | string | query | Hayır | URL’nin geçerlilik süresi (saniye olarak, varsayılan: 3600) |
Yanıt:
{
"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:
# Get the presigned URL with required parameters
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")
# Upload the file
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.
Site deneyiminizi iyileştirmek, içerikleri kişiselleştirmek ve site trafiğini analiz etmek için çerezler kullanıyoruz. "Tümünü Kabul Et"e tıklayarak onay verirsiniz.