API-referencia: szervezetek
API-referencia a szervezetek kezelésére és a felhasználók adminisztrációjára szolgáló végpontokhoz.
warning
Az adatkészlet törlése véglegesen eltávolítja az összes hozzá tartozó datatable-t és adatot. Ez a művelet nem vonható vissza.
Használat:
# 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
Az előre aláírt URL-ek csak korlátozott ideig érvényesek. A megszerzésük után mielőbb használja fel őket. Sikertelen feltöltés esetén kérjen új előre aláírt URL-t.
Használat:
# 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
A feltöltött datatable-ök megőrzik az eredeti fájlformátumot (CSV, Parquet, ORC, JSONL vagy Excel). A szimulációs eredmények fájlformátuma mindig CSV.
Használat:
# 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
A datatable-be először be kell tölteni az adatokat, csak ezután használhatók a deltafeltöltések. A deltafájlnak az eredeti feltöltéssel azonos formátumúnak kell lennie (például CSV-hez CSV-delta, Parquethez Parquet-delta), és az oszlopainak is meg kell egyezniük. Deltafeltöltéshez Excel- és XES-fájlok nem használhatók.
info
Az előre aláírt URL-en keresztüli feltöltés után a ProcessMind automatikusan feldolgozza a deltát, és egyesíti az eredeti adatokkal. A feldolgozás befejezésének ellenőrzéséhez kérdezze le a GET /datatables/{dataTableId} értékét, amíg a hasDataLoaded állapota true nem lesz.
Az adatkészletek logikailag összetartozó datatable-ök gyűjteményei.
Végpont: GET /v1/tenant/{tenantId}/datasets
Hitelesítés: Tenanthez kötött API-kulcs · read hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| limit | integer | lekérdezés | Nem | A visszaadandó elemek maximális száma |
| offset | integer | lekérdezés | Nem | Kihagyandó elemek száma |
Válasz (200):
Adatkészletek listája
[
{
"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"
}
] Hibák:
Végpont: POST /v1/tenant/{tenantId}/datasets
Hitelesítés: Tenanthez kötött API-kulcs · write hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
Kérés törzse:
{
"displayName": "string",
"treeParentId": "00000000-0000-0000-0000-000000000000",
"treeNodeType": "Dataset"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| displayName | string | Igen | Az adathierarchiában megjelenő adatkészletnév Maximális hossz: 128 |
| treeParentId | string | Nem | Szülőmappa azonosítója (null = legfelső szint) Formátum: uuid |
| treeNodeType | Dataset | TreeGroup | Nem | Adatkészlet vagy mappa Engedélyezett értékek: Dataset, TreeGroupAlapértelmezett: Dataset |
Válasz (201):
Létrehozott adatkészlet
{
"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"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| id | string | Igen | Formátum: uuid |
| treeParentId | string | Igen | Formátum: uuid |
| treeNodeType | Dataset | TreeGroup | Igen | Engedélyezett értékek: Dataset, TreeGroupAlapértelmezett: Dataset |
| displayName | string | Igen | Alapértelmezett: ""Maximális hossz: 128 |
| createdAt | string | Igen | Formátum: date-time |
| updatedAt | string | Igen | Formátum: date-time |
| dataTableId | string | Igen | Formátum: uuid |
Hibák:
Végpont: GET /v1/tenant/{tenantId}/datasets/{datasetId}
Hitelesítés: Tenanthez kötött API-kulcs · read hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| datasetId | string | útvonal | Igen | Formátum: uuid |
Válasz (200):
Adatkészlet
{
"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"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| id | string | Igen | Formátum: uuid |
| treeParentId | string | Igen | Formátum: uuid |
| treeNodeType | Dataset | TreeGroup | Igen | Engedélyezett értékek: Dataset, TreeGroupAlapértelmezett: Dataset |
| displayName | string | Igen | Alapértelmezett: ""Maximális hossz: 128 |
| createdAt | string | Igen | Formátum: date-time |
| updatedAt | string | Igen | Formátum: date-time |
| dataTableId | string | Igen | Formátum: uuid |
Hibák:
Végpont: DELETE /v1/tenant/{tenantId}/datasets/{datasetId}
Hitelesítés: Tenanthez kötött API-kulcs · write hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| datasetId | string | útvonal | Igen | Formátum: uuid |
Válasz (200):
Adatkészlet törölve
{
"success": true,
"message": "string"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| success | boolean | Igen | |
| message | string | Igen |
Hibák:
Végpont: GET /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Hitelesítés: Tenanthez kötött API-kulcs · read hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| datasetId | string | útvonal | Igen | Formátum: uuid |
| limit | integer | lekérdezés | Nem | A visszaadandó elemek maximális száma |
| offset | integer | lekérdezés | Nem | Kihagyandó elemek száma |
Válasz (200):
Az adatkészlet datatable-jeinek listája
[
{
"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"
}
}
] Hibák:
Végpont: POST /v1/tenant/{tenantId}/datasets/{datasetId}/datatables
Hitelesítés: Tenanthez kötött API-kulcs · write hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| datasetId | string | útvonal | Igen | Formátum: uuid |
Kérés törzse:
{
"displayName": "string"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| displayName | string | Igen | Datatable neve Maximális hossz: 128 |
Válasz (201):
Létrehozott 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"
}
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| id | string | Igen | Formátum: uuid |
| datasetId | string | Igen | Formátum: uuid |
| displayName | string | Igen | Alapértelmezett: ""Maximális hossz: 128 |
| createdAt | string | Igen | Formátum: date-time |
| updatedAt | string | Igen | Formátum: date-time |
| hasDataLoaded | boolean | Igen | Alapértelmezett: false |
| filterExpression | string | Igen | Maximális hossz: 4096 |
| metaInfo | object | object | object | object | Igen |
Hibák:
A datatable-ök tárolják a process mininghez használt eseménynapló-adatokat.
Végpont: GET /v1/tenant/{tenantId}/datatables
Hitelesítés: Tenanthez kötött API-kulcs · read hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| limit | integer | lekérdezés | Nem | A visszaadandó elemek maximális száma |
| offset | integer | lekérdezés | Nem | Kihagyandó elemek száma |
Válasz (200):
Datatable-ök listája
[
{
"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"
}
}
] Hibák:
Végpont: GET /v1/tenant/{tenantId}/datatables/{dataTableId}
Hitelesítés: Tenanthez kötött API-kulcs · read hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| dataTableId | string | útvonal | Igen | Formátum: uuid |
Válasz (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"
}
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| id | string | Igen | Formátum: uuid |
| datasetId | string | Igen | Formátum: uuid |
| displayName | string | Igen | Alapértelmezett: ""Maximális hossz: 128 |
| createdAt | string | Igen | Formátum: date-time |
| updatedAt | string | Igen | Formátum: date-time |
| hasDataLoaded | boolean | Igen | Alapértelmezett: false |
| filterExpression | string | Igen | Maximális hossz: 4096 |
| metaInfo | object | object | object | object | Igen |
Hibák:
Végpont: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}
Hitelesítés: Tenanthez kötött API-kulcs · write hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| dataTableId | string | útvonal | Igen | Formátum: uuid |
Kérés törzse:
{
"displayName": "string",
"filterExpression": "string"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| displayName | string | Nem | Datatable neve Maximális hossz: 128 |
| filterExpression | string | Nem | Az adatokra alkalmazott szűrőkifejezés Maximális hossz: 4096 |
Válasz (200):
Frissített 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"
}
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| id | string | Igen | Formátum: uuid |
| datasetId | string | Igen | Formátum: uuid |
| displayName | string | Igen | Alapértelmezett: ""Maximális hossz: 128 |
| createdAt | string | Igen | Formátum: date-time |
| updatedAt | string | Igen | Formátum: date-time |
| hasDataLoaded | boolean | Igen | Alapértelmezett: false |
| filterExpression | string | Igen | Maximális hossz: 4096 |
| metaInfo | object | object | object | object | Igen |
Hibák:
Végpont: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download
Hitelesítés: Tenanthez kötött API-kulcs · read hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| dataTableId | string | útvonal | Igen | Formátum: uuid |
Válasz (200):
Letöltési URL
{
"downloadUrl": "string",
"expiresInSeconds": 0
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| downloadUrl | string | Igen | |
| expiresInSeconds | number | Igen |
Hibák:
Az API-kulcsnak rendelkeznie kell a uploadData hatókörrel.
Végpont: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort
Hitelesítés: Tenanthez kötött API-kulcs · write hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| dataTableId | string | útvonal | Igen | Formátum: uuid |
Kérés törzse:
{
"uploadId": "string",
"uploadHandle": "string"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| uploadId | string | Igen | |
| uploadHandle | string | Igen | Az indítási lépés által visszaadott, átlátszatlan azonosító |
Válasz (200):
Megszakítva
{
"message": "string"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| message | string | Igen |
Hibák:
Az API-kulcsnak rendelkeznie kell a uploadData hatókörrel. Összeállítja a feltöltött részeket az ETag-értékek alapján, majd elindítja az eseménynapló feldolgozását.
Végpont: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete
Hitelesítés: Tenanthez kötött API-kulcs · write hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| dataTableId | string | útvonal | Igen | Formátum: uuid |
Kérés törzse:
{
"uploadId": "string",
"uploadHandle": "string",
"parts": [
{
"partNumber": 0,
"eTag": "string"
}
]
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| uploadId | string | Igen | |
| uploadHandle | string | Igen | Az indítási lépés által visszaadott, átlátszatlan azonosító |
| parts | object[] | Igen |
Válasz (200):
Befejezve ({ completed: true })
{
"message": "string"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| message | string | Igen |
Hibák:
Az API-kulcsnak rendelkeznie kell a uploadData hatókörrel. A válasz egy uploadId értéket és egy átlátszatlan uploadHandle azonosítót tartalmaz, amelyet a következő parts, complete és abort hívásokban kell megadni. Nagy fájlokhoz ajánlott.
Végpont: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate
Hitelesítés: Tenanthez kötött API-kulcs · write hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| dataTableId | string | útvonal | Igen | Formátum: uuid |
Kérés törzse:
{
"fileName": "string",
"fileSize": 0,
"fileLastModified": 0,
"partCount": 0,
"delta": true,
"datasetId": "00000000-0000-0000-0000-000000000000",
"modelId": "00000000-0000-0000-0000-000000000000"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| fileName | string | Igen | |
| fileSize | number | Igen | |
| fileLastModified | number | Igen | |
| partCount | number | Nem | Előre aláírt URL-lel ellátandó részek száma (alapértelmezés: 10) |
| delta | boolean | Nem | Delta (növekményes) feltöltésről van-e szó |
| datasetId | string | Nem | Formátum: uuid |
| modelId | string | Nem | Formátum: uuid |
Válasz (200):
Feltöltés elindítva
{
"uploadId": "string",
"uploadHandle": "string",
"partCount": 0,
"partSizeBytes": 0
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| uploadId | string | Nem | |
| uploadHandle | string | Nem | Átlátszatlan azonosító a részek, a befejezés és a megszakítás lépéseihez |
| partCount | number | Nem | |
| partSizeBytes | number | Nem |
Hibák:
Az API-kulcsnak rendelkeznie kell a uploadData hatókörrel. A rendszer minden kért részszámhoz egy előre aláírt PUT URL-t ad vissza.
Végpont: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts
Hitelesítés: Tenanthez kötött API-kulcs · write hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| dataTableId | string | útvonal | Igen | Formátum: uuid |
Kérés törzse:
{
"uploadId": "string",
"uploadHandle": "string",
"partNumbers": [
0
]
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| uploadId | string | Igen | |
| uploadHandle | string | Igen | Az indítási lépés által visszaadott, átlátszatlan azonosító |
| partNumbers | number[] | Igen |
Válasz (200):
A részek előre aláírt URL-jei ({ uploadId, parts: [{ partNumber, url }] })
{
"message": "string"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| message | string | Igen |
Hibák:
Az API-kulcsnak rendelkeznie kell a uploadData hatókörrel, a read/write hatókörtől függetlenül. A megadott filesize méretet (bájtban) a rendszer összeveti a platform maximális feltöltési méretével, majd a fájl beérkezésekor ismét ellenőrzi a tényleges méretet.
Végpont: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url
Hitelesítés: Tenanthez kötött API-kulcs · read hatókör
Paraméterek:
| Név | Típus | Hely | Kötelező | Leírás |
|---|---|---|---|---|
| tenantId | string | útvonal | Igen | Formátum: uuid |
| dataTableId | string | útvonal | Igen | Formátum: uuid |
| filename | string | lekérdezés | Igen | |
| filesize | string | lekérdezés | Igen | Fájlméret bájtban (a platform maximális feltöltési méretéhez viszonyítva ellenőrizve) |
| filelastmodified | string | lekérdezés | Igen | |
| datasetid | string | lekérdezés | Nem | Teljes (nem delta) feltöltéshez kötelező |
| modelid | string | lekérdezés | Nem | Formátum: uuid |
| delta | true | false | lekérdezés | Nem | Engedélyezett értékek: true, false |
| partnumber | string | lekérdezés | Nem | |
| validforseconds | integer | lekérdezés | Nem | Az előre aláírt URL érvényességi ideje másodpercben (1–3600, alapértelmezés: 3600) |
Válasz (200):
Előre aláírt URL
{
"PreSignedUploadUrl": "string"
} | Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
| PreSignedUploadUrl | string | Igen | Előre aláírt S3 PUT URL (kb. 1 óráig érvényes) |
Hibák:
Azonnal hozzáférhet, bankkártya és várakozás nélkül. Alakítsa szervezete működését világos, összekapcsolt folyamatmodellekké.
Építse fel folyamatarchitektúráját, határozza meg a felelősségi köröket és az ellenőrzéseket, és hangolja össze a szerepeket minden szinten.
Indítsa el az ingyenes próbaverziót, és teremtsen megbízható alapot folyamatainak irányításához, kezeléséhez és folyamatos fejlesztéséhez.
Sütiket használunk a felhasználói élmény javítására, a tartalom személyre szabására és a forgalom elemzésére. Az oldalmegtekintéseket sütik nélkül is névtelenül mérjük. Az analitikai sütik használatához adott hozzájárulás olyan azonosítót engedélyez, amely összekapcsolja az Ön látogatásait. Az „Összes elfogadása” gombra kattintva hozzájárul a sütik használatához.