Référence API : Organisations
Référence API pour la gestion des organisations et des utilisateurs.
Un dataset regroupe plusieurs datatables liées logiquement.
Affichez tous les datasets dans un tenant.
Endpoint : GET /tenant/{tenantId}/datasets
Paramètres :
| Nom | Type | Localisation | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
[
{
"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"displayName": "Sales Data",
"createdAt": "2024-01-20T08:00:00Z",
"datatableCount": 3
}
]
Créez un nouveau dataset dans un tenant.
Endpoint : POST /tenant/{tenantId}/datasets
Paramètres :
| Nom | Type | Localisation | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Corps de la requête :
{
"displayName": "My New Dataset",
"treeNodeType": "Dataset",
"treeParentId": null
}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| displayName | string | Oui | Nom du dataset |
| treeNodeType | string | Non | Doit être Dataset (par défaut) ou TreeGroup |
| treeParentId | string | Non | ID du dossier parent pour organiser vos datasets |
Réponse : Retourne l’objet dataset créé.
Consultez les détails d’un dataset spécifique.
Endpoint : GET /tenant/{tenantId}/datasets/{datasetId}
Paramètres :
| Nom | Type | Localisation | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
| datasetId | string | path | Oui | Identifiant unique du dataset |
Réponse :
{
"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
}
]
}
Supprimez un dataset et toutes ses datatables.
Endpoint : DELETE /tenant/{tenantId}/datasets/{datasetId}
Paramètres :
| Nom | Type | Localisation | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
| datasetId | string | path | Oui | Identifiant unique du dataset |
Réponse :
{
"success": true
}
warning
La suppression d’un dataset supprime définitivement toutes les datatables et data associées. Action irréversible.
Les datatables stockent les données de logs event utilisées pour le Process Mining.
Affichez toutes les datatables dans un tenant.
Endpoint : GET /tenant/{tenantId}/datatables
Paramètres :
| Nom | Type | Localisation | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
Réponse :
[
{
"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
"displayName": "Orders 2024",
"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"rowCount": 15000,
"createdAt": "2024-01-25T10:00:00Z"
}
]
Créez une nouvelle datatable dans un dataset existant.
Endpoint : POST /tenant/{tenantId}/datasets/{datasetId}/datatables
Paramètres :
| Nom | Type | Localisation | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
| datasetId | string | path | Oui | Identifiant unique du dataset |
Corps de la requête :
{
"displayName": "Orders Q1 2024"
}
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| displayName | string | Oui | Nom de la datatable |
Réponse : Retourne l’objet datatable créé.
Consultez les détails d’une datatable spécifique.
Endpoint : GET /tenant/{tenantId}/datatable/{datatableId}
Paramètres :
| Nom | Type | Localisation | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
| datatableId | string | path | Oui | Identifiant unique de la datatable |
Réponse :
{
"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"
}
Générez une URL temporaire pour téléverser un fichier dans une datatable.
Endpoint : GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl
Paramètres :
| Nom | Type | Localisation | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | Identifiant unique du tenant |
| datatableId | string | path | Oui | Identifiant unique de la datatable |
| datasetid | string | query | Oui | Identifiant unique du dataset |
| filename | string | query | Oui | Nom du fichier à téléverser |
| filesize | string | query | Oui | Taille du fichier en octets |
| filelastmodified | string | query | Oui | Timestamp de la dernière modif du fichier |
| validforseconds | string | query | Non | Durée de validité de l’URL en secondes (défaut: 3600) |
Réponse :
{
"PreSignedUploadUrl": "https://s3.amazonaws.com/bucket/path?X-Amz-Algorithm=AWS4-HMAC-SHA256&..."
}
Utilisation : Utilisez l’URL retournée pour téléverser un fichier avec HTTP PUT :
# Obtenir l’URL pré-signée avec les paramètres requis
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")
# Téléversez le fichier
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"
info
Les URLs pré-signées expirent après un certain temps. Utilisez l’URL rapidement après l’avoir obtenue. En cas d’échec du téléversement, demandez une nouvelle URL pré-signée.