API referansı: Kuruluşlar
Kuruluş yönetimi ve kullanıcı yönetimi uç noktaları için API referansı.
warning
Bir veri setini silmek, ilişkili tüm datatableları 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
İmzalı URL’lerin süresi sınırlı bir süre sonra dolar. URL’yi aldıktan hemen sonra kullanın. Yükleme başarısız olursa yeni bir imzalı 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 datatablelar için özgün dosya biçimi korunur (CSV, Parquet, ORC, JSONL veya Excel). Simülasyon sonuçlarında dosya 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
Delta yüklemelerini kullanabilmek için datatablea önceden ilk verilerin yüklenmiş olması gerekir. Delta dosyası, özgün yüklemeyle aynı biçimi kullanmalı ve aynı sütun yapısına sahip olmalıdır. Örneğin CSV özgün dosya için CSV delta, Parquet özgün dosya için Parquet delta kullanın. Excel ve XES dosyaları delta yüklemelerinde desteklenmez.
info
İmzalı URL üzerinden yükleme yaptıktan sonra ProcessMind deltayı otomatik olarak işler ve özgün verilerle birleştirir. İşlemin ne zaman tamamlandığını öğrenmek için GET /datatables/{dataTableId} sorgusunu hasDataLoaded değeri true olduğunda kadar sürdürün.
Veri setleri, mantıksal olarak birlikte bulunan ilişkili datatable koleksiyonlarıdır.
Uç nokta: GET /v1/tenant/{tenantId}/datasets
Kimlik doğrulama: Tenant kapsamlı 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 maksimum öğ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:
Uç nokta: POST /v1/tenant/{tenantId}/datasets
Kimlik doğrulama: Tenant kapsamlı 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 | Gerekli | 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 = üst düzey) Biçim: uuid |
| treeNodeType | Dataset | TreeGroup | Hayır | Veri seti veya klasör İzin verilen değerler: Dataset, TreeGroupVarsayı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 | Gerekli | Açıklama |
|---|---|---|---|
| id | string | Evet | Biçim: uuid |
| treeParentId | string | Evet | Biçim: uuid |
| treeNodeType | Dataset | TreeGroup | Evet | İzin verilen değerler: Dataset, TreeGroupVarsayı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:
Uç nokta: GET /v1/tenant/{tenantId}/datasets/{datasetId}
Kimlik doğrulama: Tenant kapsamlı API anahtarı · read kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| datasetId | string | path | 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 | Gerekli | Açıklama |
|---|---|---|---|
| id | string | Evet | Biçim: uuid |
| treeParentId | string | Evet | Biçim: uuid |
| treeNodeType | Dataset | TreeGroup | Evet | İzin verilen değerler: Dataset, TreeGroupVarsayı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:
Uç nokta: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}
Kimlik doğrulama: Tenant kapsamlı API anahtarı · write kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| datasetId | string | path | Evet | Biçim: uuid |
Yanıt (200):
Veri seti silindi
{
"success": true,
"message": "string"
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| success | boolean | Evet | |
| message | string | Evet |
Hatalar:
Uç nokta: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Kimlik doğrulama: Tenant kapsamlı API anahtarı · read kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| datasetId | string | path | Evet | Biçim: uuid |
| limit | integer | query | Hayır | Döndürülecek maksimum öğe sayısı |
| offset | integer | query | Hayır | Atlanacak öğe sayısı |
Yanıt (200):
Veri setindeki 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:
Uç nokta: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Kimlik doğrulama: Tenant kapsamlı API anahtarı · write kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| datasetId | string | path | Evet | Biçim: uuid |
İstek gövdesi:
{
"displayName": "string"
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| displayName | string | Evet | Datatable adı Maksimum uzunluk: 128 |
Yanıt (201):
Oluşturulan 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 | Gerekli | 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:
Datatablelar, Process Mining için kullanılan gerçek Event Log verilerini depolar.
Uç nokta: GET /v1/tenant/{tenantId}/datatables
Kimlik doğrulama: Tenant kapsamlı 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 maksimum öğe sayısı |
| offset | integer | query | 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:
Uç nokta: GET /v1/tenant/{tenantId}/datatables/{dataTableId}
Kimlik doğrulama: Tenant 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 |
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 | Gerekli | 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:
Uç nokta: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}
Kimlik doğrulama: Tenant kapsamlı API anahtarı · write kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| dataTableId | string | path | Evet | Biçim: uuid |
İstek gövdesi:
{
"displayName": "string",
"filterExpression": "string"
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| displayName | string | Hayır | Datatable adı Maksimum uzunluk: 128 |
| filterExpression | string | Hayır | Verilere uygulanan filtre ifadesi Maksimum uzunluk: 4096 |
Yanıt (200):
Güncellenen 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 | Gerekli | 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:
Uç nokta: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download
Kimlik doğrulama: Tenant 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 |
Yanıt (200):
İndirme URL’si
{
"downloadUrl": "string",
"expiresInSeconds": 0
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| downloadUrl | string | Evet | |
| expiresInSeconds | number | Evet |
Hatalar:
API anahtarında uploadData kapsamı gerekir.
Uç nokta: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort
Kimlik doğrulama: Tenant kapsamlı API anahtarı · write kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| dataTableId | string | path | Evet | Biçim: uuid |
İstek gövdesi:
{
"uploadId": "string",
"uploadHandle": "string"
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| uploadId | string | Evet | |
| uploadHandle | string | Evet | Başlatma adımında döndürülen opak tanıtıcı |
Yanıt (200):
İptal edildi
{
"message": "string"
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| message | string | Evet |
Hatalar:
API anahtarında uploadData kapsamı gerekir. Yüklenen parçaları ETag değerlerini kullanarak birleştirir ve Event Log işleme sürecini başlatır.
Uç nokta: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete
Kimlik doğrulama: Tenant kapsamlı API anahtarı · write kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| dataTableId | string | path | Evet | Biçim: uuid |
İstek gövdesi:
{
"uploadId": "string",
"uploadHandle": "string",
"parts": [
{
"partNumber": 0,
"eTag": "string"
}
]
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| uploadId | string | Evet | |
| uploadHandle | string | Evet | Başlatma adımında döndürülen opak tanıtıcı |
| parts | object[] | Evet |
Yanıt (200):
Tamamlandı ({ completed: true })
{
"message": "string"
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| message | string | Evet |
Hatalar:
API anahtarında uploadData kapsamı bulunmalıdır. Sonraki uploadId, uploadHandle ve parts çağrılarında kullanılmak üzere bir complete ve opak bir abort 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: Tenant kapsamlı API anahtarı · write kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| dataTableId | string | path | 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 | Gerekli | Açıklama |
|---|---|---|---|
| fileName | string | Evet | |
| fileSize | number | Evet | |
| fileLastModified | number | Evet | |
| partCount | number | Hayır | İmzalanacak parça sayısı (varsayılan 10) |
| delta | boolean | Hayır | Bunun delta (artımlı) yükleme olup olmadığı |
| datasetId | string | Hayır | Biçim: uuid |
| modelId | string | Hayır | Biçim: uuid |
Yanıt (200):
Başlatılan yükleme
{
"uploadId": "string",
"uploadHandle": "string",
"partCount": 0,
"partSizeBytes": 0
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| uploadId | string | Hayır | |
| uploadHandle | string | Hayır | Parçalar, tamamlama ve iptal adımları için opak tanıtıcı |
| partCount | number | Hayır | |
| partSizeBytes | number | Hayır |
Hatalar:
API anahtarında uploadData kapsamı gerekir. İstenen her parça numarası için bir imzalı PUT URL’si döndürür.
Uç nokta: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts
Kimlik doğrulama: Tenant kapsamlı API anahtarı · write kapsamı
Parametreler:
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Biçim: uuid |
| dataTableId | string | path | Evet | Biçim: uuid |
İstek gövdesi:
{
"uploadId": "string",
"uploadHandle": "string",
"partNumbers": [
0
]
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| uploadId | string | Evet | |
| uploadHandle | string | Evet | Başlatma adımında döndürülen opak tanıtıcı |
| partNumbers | number[] | Evet |
Yanıt (200):
Parça imzalı URL’leri ({ uploadId, parts: [{ partNumber, url }] })
{
"message": "string"
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| message | string | Evet |
Hatalar:
API anahtarında uploadData kapsamı gerekir (read/write kapsamlarından bağımsızdır). Bildirilen filesize değeri (bayt cinsinden), planın maksimum yükleme boyutuna göre denetlenir. Dosya ulaştığında gerçek nesne boyutu yeniden doğrulanır.
Uç nokta: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url
Kimlik doğrulama: Tenant 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 cinsinden (planın maksimum yükleme boyutuna göre denetlenir) |
| filelastmodified | string | query | Evet | |
| datasetid | string | query | Hayır | Tam (delta olmayan) yüklemeler 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 saniye cinsinden geçerlilik süresi (1–3600, varsayılan 3600) |
Yanıt (200):
İmzalı URL
{
"PreSignedUploadUrl": "string"
} | Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
| PreSignedUploadUrl | string | Evet | İmzalı S3 PUT URL’si (yaklaşık 1 saat geçerli) |
Hatalar:
Deneyiminizi iyileştirmek, içeriği kişiselleştirmek ve trafiği analiz etmek için çerezleri kullanıyoruz. "Tümünü kabul et" seçeneğine tıklayarak çerezleri kullanmamıza izin vermiş olursunuz.