Liste des documents
Sur cette page

Documentation API : Data

Endpoints Dataset

Un dataset regroupe plusieurs datatables liées logiquement.

Lister les Datasets

Affichez tous les datasets dans un tenant.

Endpoint : GET /tenant/{tenantId}/datasets

Paramètres :

NomTypeLocalisationObligatoireDescription
tenantIdstringpathOuiIdentifiant unique du tenant

Réponse :

[
	{
		"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
		"displayName": "Sales Data",
		"createdAt": "2024-01-20T08:00:00Z",
		"datatableCount": 3
	}
]

Créer un Dataset

Créez un nouveau dataset dans un tenant.

Endpoint : POST /tenant/{tenantId}/datasets

Paramètres :

NomTypeLocalisationObligatoireDescription
tenantIdstringpathOuiIdentifiant unique du tenant

Corps de la requête :

{
	"displayName": "My New Dataset",
	"treeNodeType": "Dataset",
	"treeParentId": null
}
ChampTypeObligatoireDescription
displayNamestringOuiNom du dataset
treeNodeTypestringNonDoit être Dataset (par défaut) ou TreeGroup
treeParentIdstringNonID du dossier parent pour organiser vos datasets

Réponse : Retourne l’objet dataset créé.


Obtenir un Dataset

Consultez les détails d’un dataset spécifique.

Endpoint : GET /tenant/{tenantId}/datasets/{datasetId}

Paramètres :

NomTypeLocalisationObligatoireDescription
tenantIdstringpathOuiIdentifiant unique du tenant
datasetIdstringpathOuiIdentifiant 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
		}
	]
}

Supprimer un Dataset

Supprimez un dataset et toutes ses datatables.

Endpoint : DELETE /tenant/{tenantId}/datasets/{datasetId}

Paramètres :

NomTypeLocalisationObligatoireDescription
tenantIdstringpathOuiIdentifiant unique du tenant
datasetIdstringpathOuiIdentifiant 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.


Endpoints Datatable

Les datatables stockent les données de logs event utilisées pour le Process Mining.

Lister les Datatables

Affichez toutes les datatables dans un tenant.

Endpoint : GET /tenant/{tenantId}/datatables

Paramètres :

NomTypeLocalisationObligatoireDescription
tenantIdstringpathOuiIdentifiant 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éer une Datatable

Créez une nouvelle datatable dans un dataset existant.

Endpoint : POST /tenant/{tenantId}/datasets/{datasetId}/datatables

Paramètres :

NomTypeLocalisationObligatoireDescription
tenantIdstringpathOuiIdentifiant unique du tenant
datasetIdstringpathOuiIdentifiant unique du dataset

Corps de la requête :

{
	"displayName": "Orders Q1 2024"
}
ChampTypeObligatoireDescription
displayNamestringOuiNom de la datatable

Réponse : Retourne l’objet datatable créé.


Obtenir une Datatable

Consultez les détails d’une datatable spécifique.

Endpoint : GET /tenant/{tenantId}/datatable/{datatableId}

Paramètres :

NomTypeLocalisationObligatoireDescription
tenantIdstringpathOuiIdentifiant unique du tenant
datatableIdstringpathOuiIdentifiant 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"
}

Obtenir une URL de téléversement pré-signée

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 :

NomTypeLocalisationObligatoireDescription
tenantIdstringpathOuiIdentifiant unique du tenant
datatableIdstringpathOuiIdentifiant unique de la datatable
datasetidstringqueryOuiIdentifiant unique du dataset
filenamestringqueryOuiNom du fichier à téléverser
filesizestringqueryOuiTaille du fichier en octets
filelastmodifiedstringqueryOuiTimestamp de la dernière modif du fichier
validforsecondsstringqueryNonDuré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.