Bu sayfada

API referansı: veri

warning

Bir veri setini silmek, ilişkili tüm veri tablolarını ve verileri kalıcı olarak kaldırır. Bu işlem geri alınamaz.

Kullanım:

# 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

Önceden imzalanmış URL’lerin süresi sınırlıdır. URL’yi aldıktan kısa süre sonra kullanın. Yükleme başarısız olursa yeni bir önceden imzalanmış URL isteyin.

Kullanım:

# 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

Yüklenen veri tablolarında özgün dosya biçimi korunur (CSV, Parquet, ORC, JSONL veya Excel). Simülasyon sonuçları ise her zaman CSV biçimindedir.

Kullanım:

# 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

Artımlı yükleme yapılabilmesi için veri tablosuna önce başlangıç verileri yüklenmiş olmalıdır. Artımlı dosya, ilk yüklemedeki dosyayla aynı biçimde (örneğin, CSV dosyası için artımlı CSV dosyası, Parquet dosyası için artımlı Parquet dosyası) ve aynı sütun yapısında olmalıdır. Excel ve XES dosyaları artımlı yüklemelerde desteklenmez.

info

Önceden imzalanmış URL üzerinden yükleme yaptıktan sonra ProcessMind, artımlı verileri otomatik olarak işler ve özgün verilerle birleştirir. İşlemin ne zaman tamamlandığını öğrenmek için GET /datatables/{dataTableId} adresini, hasDataLoaded değeri true olana kadar sorgulayın.

Veri setleri, mantıksal olarak birbiriyle ilişkili veri tablolarını bir araya getirir.

Veri setlerini listeleme

Uç nokta: GET /v1/tenant/{tenantId}/datasets

Kimlik doğrulama: Kiracı kapsamındaki API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Gerekli Açıklama
tenantId string path Evet Biçim: uuid
limit integer query Hayır Döndürülecek en fazla öğe sayısı
offset integer query Hayır Atlanacak öğe sayısı

Yanıt (200):

Veri setleri listesi

[
	{
		"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"
	}
]

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş

Veri seti oluşturma (boş bir veri tablosuyla birlikte)

Uç nokta: POST /v1/tenant/{tenantId}/datasets

Kimlik doğrulama: Kiracı kapsamındaki API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Gerekli Açıklama
tenantId string path Evet Biçim: uuid

İstek gövdesi:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset"
}
Alan Tür Zorunlu Açıklama
displayName string Evet Veri ağacında gösterilen Veri Seti adı
Maksimum uzunluk: 128
treeParentId string Hayır Üst klasör kimliği (null = en üst düzey)
Biçim: uuid
treeNodeType Dataset | TreeGroup Hayır Veri Seti veya klasör
İzin verilen değerler: Dataset, TreeGroup
Varsayılan: Dataset

Yanıt (201):

Oluşturulan Veri Seti

{
	"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"
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
treeParentId string Evet Biçim: uuid
treeNodeType Dataset | TreeGroup Evet İzin verilen değerler: Dataset, TreeGroup
Varsayılan: Dataset
displayName string Evet Varsayılan: ""
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
updatedAt string Evet Biçim: date-time
dataTableId string Evet Biçim: uuid

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş

Veri Seti alın

Uç nokta: GET /v1/tenant/{tenantId}/datasets/{datasetId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
datasetId string yol Evet Biçim: uuid

Yanıt (200):

Veri Seti

{
	"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"
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
treeParentId string Evet Biçim: uuid
treeNodeType Dataset | TreeGroup Evet İzin verilen değerler: Dataset, TreeGroup
Varsayılan: Dataset
displayName string Evet Varsayılan: ""
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
updatedAt string Evet Biçim: date-time
dataTableId string Evet Biçim: uuid

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Veri Seti silme işlemini geri alınabilir şekilde yapın

Uç nokta: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
datasetId string yol Evet Biçim: uuid

Yanıt (200):

Veri Seti silindi

{
	"success": true,
	"message": "string"
}
Alan Tür Zorunlu Açıklama
success boolean Evet
message string Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Veri Setindeki datatable’ları listeleyin

Uç nokta: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
datasetId string yol Evet Biçim: uuid
limit integer sorgu Hayır Döndürülecek en fazla öğe sayısı
offset integer sorgu Hayır Atlanacak öğe sayısı

Yanıt (200):

Veri Setindeki datatable’ların listesi

[
	{
		"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"
		}
	}
]

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Veri Setinde boş bir datatable oluşturun

Uç nokta: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
datasetId string yol Evet Biçim: uuid

İstek gövdesi:

{
	"displayName": "string"
}
Alan Tür Zorunlu Açıklama
displayName string Evet Datatable adı
Maksimum uzunluk: 128

Yanıt (201):

Datatable oluşturuldu

{
	"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"
	}
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
datasetId string Evet Biçim: uuid
displayName string Evet Varsayılan: ""
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
updatedAt string Evet Biçim: date-time
hasDataLoaded boolean Evet Varsayılan: false
filterExpression string Evet Maksimum uzunluk: 4096
metaInfo object | object | object | object Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Datatable’lar, Process Mining için kullanılan gerçek olay günlüğü verilerini saklar.

Datatable’ları listeleyin

Uç nokta: GET /v1/tenant/{tenantId}/datatables

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
limit integer sorgu Hayır Döndürülecek en fazla öğe sayısı
offset integer sorgu Hayır Atlanacak öğe sayısı

Yanıt (200):

Datatable listesi

[
	{
		"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"
		}
	}
]

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş

Datatable alın

Uç nokta: GET /v1/tenant/{tenantId}/datatables/{dataTableId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
dataTableId string yol Evet Biçim: uuid

Yanıt (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"
	}
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
datasetId string Evet Biçim: uuid
displayName string Evet Varsayılan: ""
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
updatedAt string Evet Biçim: date-time
hasDataLoaded boolean Evet Varsayılan: false
filterExpression string Evet Maksimum uzunluk: 4096
metaInfo object | object | object | object Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Datatable’ı güncelleyin (displayName, parseSettings, …)

Uç nokta: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
dataTableId string yol Evet Biçim: uuid

İstek gövdesi:

{
	"displayName": "string",
	"filterExpression": "string"
}
Alan Tür Zorunlu Açıklama
displayName string Hayır Datatable adı
Maksimum uzunluk: 128
filterExpression string Hayır Veriye uygulanan filtre ifadesi
Maksimum uzunluk: 4096

Yanıt (200):

Datatable güncellendi

{
	"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"
	}
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
datasetId string Evet Biçim: uuid
displayName string Evet Varsayılan: ""
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
updatedAt string Evet Biçim: date-time
hasDataLoaded boolean Evet Varsayılan: false
filterExpression string Evet Maksimum uzunluk: 4096
metaInfo object | object | object | object Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Datatable kaynak dosyasını indirmek için önceden imzalanmış URL alın

Uç nokta: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
dataTableId string yol Evet Biçim: uuid

Yanıt (200):

İndirme URL’si

{
	"downloadUrl": "string",
	"expiresInSeconds": 0
}
Alan Tür Zorunlu Açıklama
downloadUrl string Evet
expiresInSeconds number Evet

Hatalar:

  • 400 Hatalı istek: örneğin geçersiz bir filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen bir yükleme türü veya eksik bir zorunlu alan
  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Çok parçalı yüklemeyi iptal edin ve yüklenen parçaları silin

API anahtarında uploadData kapsamı gerekir.

Uç nokta: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
dataTableId string yol Evet Biçim: uuid

İstek gövdesi:

{
	"uploadId": "string",
	"uploadHandle": "string"
}
Alan Tür Zorunlu Açıklama
uploadId string Evet
uploadHandle string Evet Başlatma adımının döndürdüğü opak tanıtıcı

Yanıt (200):

İptal edildi

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü engelliyor
  • 404 Kaynak bulunamadı

Çok parçalı yüklemeyi tamamlayın (3. adım/3)

API anahtarında uploadData kapsamı gerekir. Yüklenen parçaları (ETag değerlerini kullanarak) birleştirir ve olay günlüğü işlemeyi başlatır.

Uç nokta: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
dataTableId string yol Evet Biçim: uuid

İstek gövdesi:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"parts": [
		{
			"partNumber": 0,
			"eTag": "string"
		}
	]
}
Alan Tür Zorunlu Açıklama
uploadId string Evet
uploadHandle string Evet Başlatma adımının döndürdüğü opak tanıtıcı
parts object[] Evet

Yanıt (200):

Tamamlandı ({ completed: true })

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü engelliyor
  • 404 Kaynak bulunamadı

Olay günlüğü verileri için çok parçalı (parçalı) yükleme başlatın (1. adım/3)

API anahtarında uploadData kapsamı gerekir. Bir uploadId ve sonraki parts, complete ve abort çağrılarında kullanılacak opak bir uploadHandle döndürür. Büyük dosyalar için uygundur.

Uç nokta: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
dataTableId string yol Evet Biçim: uuid

İstek gövdesi:

{
	"fileName": "string",
	"fileSize": 0,
	"fileLastModified": 0,
	"partCount": 0,
	"delta": true,
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000"
}
Alan Tür Zorunlu Açıklama
fileName string Evet
fileSize number Evet
fileLastModified number Evet
partCount number Hayır Önceden imzalanacak parça sayısı (varsayılan 10)
delta boolean Hayır Bunun artımlı (delta) bir yükleme olup olmadığı
datasetId string Hayır Biçim: uuid
modelId string Hayır Biçim: uuid

Yanıt (200):

Yükleme başlatıldı

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partCount": 0,
	"partSizeBytes": 0
}
Alan Tür Zorunlu Açıklama
uploadId string Hayır
uploadHandle string Hayır Parça/tamamlama/iptal adımlarında kullanılan opak tanıtıcı
partCount number Hayır
partSizeBytes number Hayır

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü engelliyor
  • 404 Kaynak bulunamadı

Çok parçalı yüklemenin parçaları için önceden imzalanmış URL’leri alın (2. adım/3)

API anahtarında uploadData kapsamı gerekir. İstenen her parça numarası için bir önceden imzalanmış PUT URL’si döndürür.

Uç nokta: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
dataTableId string yol Evet Biçim: uuid

İstek gövdesi:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partNumbers": [
		0
	]
}
Alan Tür Zorunlu Açıklama
uploadId string Evet
uploadHandle string Evet Başlatma adımının döndürdüğü opak tanıtıcı
partNumbers number[] Evet

Yanıt (200):

Parçalar için önceden imzalanmış URL’ler ({ uploadId, parts: [{ partNumber, url }] })

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü engelliyor
  • 404 Kaynak bulunamadı

Olay günlüğü verileri için önceden imzalanmış S3 yükleme URL’si alın (CSV/XLSX, tam veya delta)

API anahtarında uploadData kapsamı gerekir (okuma/yazma izinlerinden bağımsızdır). Belirtilen filesize (bayt cinsinden) değer, platformun en büyük yükleme boyutuyla karşılaştırılarak denetlenir. Dosya yüklendiğinde gerçek nesne boyutu yeniden doğrulanır.

Uç nokta: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Gerekli Açıklama
tenantId string path Evet Biçim: uuid
dataTableId string path Evet Biçim: uuid
filename string query Evet
filesize string query Evet Dosya boyutu (bayt); platformun en büyük yükleme boyutuyla karşılaştırılarak denetlenir
filelastmodified string query Evet
datasetid string query Hayır Tam yüklemeler (delta olmayanlar) için gereklidir
modelid string query Hayır Biçim: uuid
delta true | false query Hayır İzin verilen değerler: true, false
partnumber string query Hayır
validforseconds integer query Hayır İmzalı URL’nin geçerlilik süresi, saniye cinsinden (1–3600, varsayılan 3600)

Yanıt (200):

Önceden imzalanmış URL

{
	"PreSignedUploadUrl": "string"
}
Alan Tür Zorunlu Açıklama
PreSignedUploadUrl string Evet Önceden imzalanmış S3 PUT URL’si (yaklaşık 1 saat geçerli)

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türüne izin vermiyor
  • 404 Kaynak bulunamadı
  • 413 Dosya, platformun en büyük yükleme boyutunu aşıyor

Süreçlerinizi daha iyi tasarlayın. Bağlantılı bir mimari kurun. Kontrolü elinizde tutun.

Kredi kartı gerekmeden, beklemeden hemen erişin. Kuruluşunuzdaki çalışma biçimini net ve birbiriyle bağlantılı süreç tasarımlarına dönüştürün.

Süreç mimarinizi oluşturun, sahiplik ve kontrolleri tanımlayın; rol ve sorumlulukları her düzeyde uyumlu hâle getirin.

Ücretsiz denemeyi başlatın; süreçlerinizi yönetmek ve sürekli iyileştirmek için güvenilir bir temel oluşturun.