En esta página

> recursos > documentacion > api > Referencia de la API: datos

Referencia de la API: datos

warning

Al eliminar un conjunto de datos, se eliminarán de forma permanente todas las tablas de datos y los datos asociados. Esta acción no se puede deshacer.

Uso:

# 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

Las URL prefirmadas caducan al cabo de un tiempo limitado. Use la URL poco después de obtenerla. Si falla la carga, solicite una nueva URL prefirmada.

Uso:

# 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

En las tablas de datos cargadas se conserva el formato del archivo original (CSV, Parquet, ORC, JSONL o Excel). Los resultados de la simulación siempre se guardan en formato CSV.

Uso:

# 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

La tabla de datos debe tener datos iniciales cargados antes de poder usar cargas delta. El archivo delta debe tener el mismo formato que el archivo original (por ejemplo, un delta CSV para un original CSV o un delta Parquet para un original Parquet) y la misma estructura de columnas. No se admiten cargas delta de archivos Excel ni XES.

info

Después de cargar el archivo mediante la URL prefirmada, ProcessMind procesa automáticamente el delta y lo combina con los datos originales. Consulte GET /datatables/{dataTableId} hasta que hasDataLoaded sea true para saber cuándo termina el procesamiento.

Los conjuntos de datos agrupan tablas de datos relacionadas que forman una unidad lógica.

Listar conjuntos de datos

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

Autenticación: Clave de API asociada a un inquilino · ámbito read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	cadena	ruta	Sí	Formato: `uuid`
limit	entero	consulta	No	Número máximo de elementos que se devolverán
offset	entero	consulta	No	Número de elementos que se omitirán

Respuesta (200):

Lista de conjuntos de datos

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

Errores:

401 Falta la clave de API, no es válida, está desactivada o ha caducado

Crear un conjunto de datos (con una tabla de datos vacía)

Endpoint: POST /v1/tenant/{tenantId}/datasets

Autenticación: Clave de API asociada a un inquilino · ámbito write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	cadena	ruta	Sí	Formato: `uuid`

Cuerpo de la solicitud:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Dataset"
}

Campo	Tipo	Obligatorio	Descripción
displayName	string	Sí	Nombre del conjunto de datos que se muestra en el árbol de datos Longitud máxima: 128
treeParentId	string	No	ID de la carpeta principal (null = nivel superior) Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	No	Conjunto de datos o carpeta Valores permitidos: `Dataset`, `TreeGroup` Valor predeterminado: `Dataset`

Respuesta (201):

Conjunto de datos creado

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

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: `uuid`
treeParentId	string	Sí	Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Sí	Valores permitidos: `Dataset`, `TreeGroup` Valor predeterminado: `Dataset`
displayName	string	Sí	Valor predeterminado: `""` Longitud máxima: 128
createdAt	string	Sí	Formato: `date-time`
updatedAt	string	Sí	Formato: `date-time`
dataTableId	string	Sí	Formato: `uuid`

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado

Obtener un conjunto de datos

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

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
datasetId	string	ruta	Sí	Formato: `uuid`

Respuesta (200):

Conjunto de datos

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

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: `uuid`
treeParentId	string	Sí	Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Sí	Valores permitidos: `Dataset`, `TreeGroup` Valor predeterminado: `Dataset`
displayName	string	Sí	Valor predeterminado: `""` Longitud máxima: 128
createdAt	string	Sí	Formato: `date-time`
updatedAt	string	Sí	Formato: `date-time`
dataTableId	string	Sí	Formato: `uuid`

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
404 No se encontró el recurso

Eliminar un conjunto de datos de forma lógica

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

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
datasetId	string	ruta	Sí	Formato: `uuid`

Respuesta (200):

Conjunto de datos eliminado

{
	"success": true,
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
success	boolean	Sí
message	string	Sí

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
404 No se encontró el recurso

Enumerar las tablas de datos de un conjunto de datos

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

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
datasetId	string	ruta	Sí	Formato: `uuid`
limit	integer	consulta	No	Número máximo de elementos que se devolverán
offset	integer	consulta	No	Número de elementos que se omitirán

Respuesta (200):

Lista de tablas de datos del conjunto de datos

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

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
404 No se encontró el recurso

Crear una tabla de datos vacía dentro de un conjunto de datos

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

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
datasetId	string	ruta	Sí	Formato: `uuid`

Cuerpo de la solicitud:

{
	"displayName": "string"
}

Campo	Tipo	Obligatorio	Descripción
displayName	string	Sí	Nombre de la tabla de datos Longitud máxima: 128

Respuesta (201):

Tabla de datos creada

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

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: `uuid`
datasetId	string	Sí	Formato: `uuid`
displayName	string	Sí	Valor predeterminado: `""` Longitud máxima: 128
createdAt	string	Sí	Formato: `date-time`
updatedAt	string	Sí	Formato: `date-time`
hasDataLoaded	boolean	Sí	Valor predeterminado: `false`
filterExpression	string	Sí	Longitud máxima: 4096
metaInfo	object \| object \| object \| object	Sí

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
404 No se encontró el recurso

Las tablas de datos almacenan los datos reales del registro de eventos que se utilizan para Process Mining.

Enumerar tablas de datos

Endpoint: GET /v1/tenant/{tenantId}/datatables

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
limit	integer	consulta	No	Número máximo de elementos que se devolverán
offset	integer	consulta	No	Número de elementos que se omitirán

Respuesta (200):

Lista de tablas de datos

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

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado

Obtener una tabla de datos

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
dataTableId	string	ruta	Sí	Formato: `uuid`

Respuesta (200):

Tabla de datos

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

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: `uuid`
datasetId	string	Sí	Formato: `uuid`
displayName	string	Sí	Valor predeterminado: `""` Longitud máxima: 128
createdAt	string	Sí	Formato: `date-time`
updatedAt	string	Sí	Formato: `date-time`
hasDataLoaded	boolean	Sí	Valor predeterminado: `false`
filterExpression	string	Sí	Longitud máxima: 4096
metaInfo	object \| object \| object \| object	Sí

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
404 No se encontró el recurso

Actualizar una tabla de datos (displayName, parseSettings, …)

Endpoint: PUT /v1/tenant/{tenantId}/datatables/{dataTableId}

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
dataTableId	string	ruta	Sí	Formato: `uuid`

Cuerpo de la solicitud:

{
	"displayName": "string",
	"filterExpression": "string"
}

Campo	Tipo	Obligatorio	Descripción
displayName	string	No	Nombre de la tabla de datos Longitud máxima: 128
filterExpression	string	No	Expresión de filtro aplicada a los datos Longitud máxima: 4096

Respuesta (200):

Tabla de datos actualizada

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

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: `uuid`
datasetId	string	Sí	Formato: `uuid`
displayName	string	Sí	Valor predeterminado: `""` Longitud máxima: 128
createdAt	string	Sí	Formato: `date-time`
updatedAt	string	Sí	Formato: `date-time`
hasDataLoaded	boolean	Sí	Valor predeterminado: `false`
filterExpression	string	Sí	Longitud máxima: 4096
metaInfo	object \| object \| object \| object	Sí

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
404 No se encontró el recurso

Obtener una URL prefirmada para descargar el archivo de origen de la tabla de datos

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/download

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
dataTableId	string	ruta	Sí	Formato: `uuid`

Respuesta (200):

URL de descarga

{
	"downloadUrl": "string",
	"expiresInSeconds": 0
}

Campo	Tipo	Obligatorio	Descripción
downloadUrl	string	Sí
expiresInSeconds	number	Sí

Errores:

400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de carga no compatible o un campo obligatorio ausente
401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
404 No se encontró el recurso

Cancelar una carga multiparte y descartar las partes cargadas

Se requiere el alcance uploadData en la clave de API.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/abort

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
dataTableId	string	ruta	Sí	Formato: `uuid`

Cuerpo de la solicitud:

{
	"uploadId": "string",
	"uploadHandle": "string"
}

Campo	Tipo	Obligatorio	Descripción
uploadId	string	Sí
uploadHandle	string	Sí	Identificador opaco devuelto en el paso de inicio

Respuesta (200):

Cancelada

{
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
message	string	Sí

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
403 La clave de API no tiene el alcance o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite este tipo de archivo
404 No se encontró el recurso

Completar una carga multiparte (paso 3 de 3)

Se requiere el alcance uploadData en la clave de API. Ensambla las partes cargadas (mediante sus ETag) e inicia el procesamiento del registro de eventos.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/complete

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
dataTableId	string	ruta	Sí	Formato: `uuid`

Cuerpo de la solicitud:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"parts": [
		{
			"partNumber": 0,
			"eTag": "string"
		}
	]
}

Campo	Tipo	Obligatorio	Descripción
uploadId	string	Sí
uploadHandle	string	Sí	Identificador opaco devuelto en el paso de inicio
parts	object[]	Sí

Respuesta (200):

Completada ({ completed: true })

{
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
message	string	Sí

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
403 La clave de API no tiene el alcance o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite este tipo de archivo
404 No se encontró el recurso

Iniciar una carga multiparte (por fragmentos) de datos del registro de eventos (paso 1 de 3)

Se requiere el alcance uploadData en la clave de API. Devuelve un uploadId y un uploadHandle opaco que se deben incluir en las llamadas posteriores parts, complete y abort. Adecuado para archivos grandes.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/initiate

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
dataTableId	string	ruta	Sí	Formato: `uuid`

Cuerpo de la solicitud:

{
	"fileName": "string",
	"fileSize": 0,
	"fileLastModified": 0,
	"partCount": 0,
	"delta": true,
	"datasetId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obligatorio	Descripción
fileName	string	Sí
fileSize	number	Sí
fileLastModified	number	Sí
partCount	number	No	Número de partes para las que se generará una firma (valor predeterminado: 10)
delta	boolean	No	Indica si se trata de una carga delta (incremental)
datasetId	string	No	Formato: `uuid`
modelId	string	No	Formato: `uuid`

Respuesta (200):

Carga iniciada

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partCount": 0,
	"partSizeBytes": 0
}

Campo	Tipo	Obligatorio	Descripción
uploadId	string	No
uploadHandle	string	No	Identificador opaco para los pasos de partes, finalización y cancelación
partCount	number	No
partSizeBytes	number	No

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
403 La clave de API no tiene el alcance o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite este tipo de archivo
404 No se encontró el recurso

Obtener URL prefirmadas para las partes de una carga multiparte (paso 2 de 3)

Se requiere el alcance uploadData en la clave de API. Devuelve una URL PUT prefirmada por cada número de parte solicitado.

Endpoint: POST /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/multipart/parts

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
dataTableId	string	ruta	Sí	Formato: `uuid`

Cuerpo de la solicitud:

{
	"uploadId": "string",
	"uploadHandle": "string",
	"partNumbers": [
		0
	]
}

Campo	Tipo	Obligatorio	Descripción
uploadId	string	Sí
uploadHandle	string	Sí	Identificador opaco devuelto en el paso de inicio
partNumbers	number[]	Sí

Respuesta (200):

URL prefirmadas de las partes ({ uploadId, parts: [{ partNumber, url }] })

{
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
message	string	Sí

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
403 La clave de API no tiene el alcance o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite este tipo de archivo
404 No se encontró el recurso

Obtener una URL de carga S3 prefirmada para datos del registro de eventos (CSV/XLSX, carga completa o delta)

Requiere el ámbito uploadData en la clave de API, independientemente de los permisos de lectura o escritura. El valor declarado de filesize (en bytes) se comprueba frente al tamaño máximo de carga de la plataforma; el tamaño real del objeto se vuelve a verificar cuando se recibe el archivo.

Endpoint: GET /v1/tenant/{tenantId}/datatables/{dataTableId}/uploads/presigned-url

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`
dataTableId	string	ruta	Sí	Formato: `uuid`
filename	string	consulta	Sí
filesize	string	consulta	Sí	Tamaño del archivo en bytes (se comprueba frente al tamaño máximo de carga de la plataforma)
filelastmodified	string	consulta	Sí
datasetid	string	consulta	No	Obligatorio para cargas completas (no incrementales)
modelid	string	consulta	No	Formato: `uuid`
delta	`true` \| `false`	consulta	No	Valores permitidos: `true`, `false`
partnumber	string	consulta	No
validforseconds	integer	consulta	No	Vigencia de la URL prefirmada en segundos (1–3600; valor predeterminado: 3600)

Respuesta (200):

URL prefirmada

{
	"PreSignedUploadUrl": "string"
}

Campo	Tipo	Obligatorio	Descripción
PreSignedUploadUrl	string	Sí	URL PUT S3 prefirmada (válida durante aproximadamente 1 h)

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha vencido
403 La clave de API no tiene el ámbito o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite este tipo de archivo
404 No se encontró el recurso
413 El archivo supera el tamaño máximo de carga de la plataforma

Documentación relacionada

Referencia de API: organizaciones

Referencia de API para los endpoints de gestión de organizaciones y administración de usuarios.

Referencia de la API: inquilinos

Referencia de la API para los endpoints de gestión de inquilinos y control de acceso de usuarios.

Referencia de la API: procesos

Referencia de la API para los endpoints de gestión de procesos y mapeo de datos.

Referencia de la API: simulaciones

Referencia de la API para la gestión de simulaciones y los endpoints de generación con IA.

Diseñe mejores procesos. Conecte su arquitectura. Mantenga el control.

Acceda de inmediato, sin tarjeta de crédito ni esperas. Transforme la forma de trabajar de su organización en diseños de procesos claros y conectados.

Defina la arquitectura de procesos, los responsables y los controles, y alinee las funciones y responsabilidades en todos los niveles.

Comience su prueba gratuita y establezca una base fiable para gobernar, gestionar y mejorar continuamente sus procesos.

Comience hoy su prueba gratuita