Referencia API: Data

Endpoints de Dataset

Los datasets son colecciones de datatables relacionadas que se agrupan de forma lógica.

Listar Datasets

Obtén todos los datasets de un tenant.

Endpoint: GET /tenant/{tenantId}/datasets

Parámetros:

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	path	Sí	Identificador único del tenant

Respuesta:

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

---

Crear Dataset

Crea un dataset nuevo en un tenant.

Endpoint: POST /tenant/{tenantId}/datasets

Parámetros:

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	path	Sí	Identificador único del tenant

Request Body:

{
	"displayName": "My New Dataset",
	"treeNodeType": "Dataset",
	"treeParentId": null
}

Campo	Tipo	Requerido	Descripción
displayName	string	Sí	Nombre del dataset
treeNodeType	string	No	Debe ser Dataset (default) o TreeGroup
treeParentId	string	No	ID de la carpeta para organizar datasets

Respuesta: Devuelve el objeto dataset creado.

---

Obtener Dataset

Consulta los detalles de un dataset específico.

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

Parámetros:

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	path	Sí	Identificador único del tenant
datasetId	string	path	Sí	Identificador único del dataset

Respuesta:

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

---

Eliminar Dataset

Elimina un dataset y todas sus datatables.

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

Parámetros:

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	path	Sí	Identificador único del tenant
datasetId	string	path	Sí	Identificador único del dataset

Respuesta:

{
	"success": true
}

---

Endpoints de Datatable

Las datatables almacenan los datos de event log que se usan para Process Mining.

Listar Datatables

Obtén todas las datatables de un tenant.

Endpoint: GET /tenant/{tenantId}/datatables

Parámetros:

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	path	Sí	Identificador único del tenant

Respuesta:

[
	{
		"id": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Orders 2024",
		"datasetId": "f6a7b8c9-d0e1-2345-fab6-789012345678",
		"rowCount": 15000,
		"createdAt": "2024-01-25T10:00:00Z"
	}
]

---

Crear Datatable

Crea una datatable nueva dentro de un dataset existente.

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

Parámetros:

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	path	Sí	Identificador único del tenant
datasetId	string	path	Sí	Identificador único del dataset

Request Body:

{
	"displayName": "Orders Q1 2024"
}

Campo	Tipo	Requerido	Descripción
displayName	string	Sí	Nombre de la datatable

Respuesta: Devuelve el objeto datatable creado.

---

Obtener Datatable

Consulta los detalles de una datatable específica.

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

Parámetros:

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	path	Sí	Identificador único del tenant
datatableId	string	path	Sí	Identificador único de la datatable

Respuesta:

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

---

Obtener URL de Subida Prefirmada

Consigue una URL temporal para subir archivos directamente a una datatable.

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

Parámetros:

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	path	Sí	Identificador único del tenant
datatableId	string	path	Sí	Identificador único de la datatable
datasetid	string	query	Sí	Identificador único del dataset
filename	string	query	Sí	Nombre del archivo a subir
filesize	string	query	Sí	Tamaño del archivo en bytes
filelastmodified	string	query	Sí	Timestamp de última modificación del archivo
validforseconds	string	query	No	Duración de la URL en segundos (por defecto: 3600)

Respuesta:

{
	"PreSignedUploadUrl": "https://s3.amazonaws.com/bucket/path?X-Amz-Algorithm=AWS4-HMAC-SHA256&..."
}

Uso: Utiliza la URL devuelta para subir un archivo con HTTP PUT:

# Obtén la URL prefirmada con los parámetros requeridos
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")

# Sube el archivo
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"