En esta página
> recursos > documentacion > api > Referencia de la API: datos

Referencia de la API: datos

warning

Eliminar un dataset eliminará permanentemente todos los datatables y 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 presignadas caducan después de un tiempo limitado. Utilice la URL poco después de obtenerla. Si la carga falla, solicite una URL presignada nueva.

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 los datatables cargados se conserva el formato del archivo original (CSV, Parquet, ORC, JSONL o Excel). En los resultados de simulación, el archivo siempre tiene 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

El datatable ya debe tener datos iniciales cargados antes de poder utilizar cargas delta. El archivo delta debe utilizar el mismo formato que la carga original (por ejemplo, un delta CSV para un original CSV o un delta Parquet para un original Parquet) y tener la misma estructura de columnas. Los archivos Excel y XES no son compatibles con las cargas delta.

info

Después de cargar el archivo mediante la URL presignada, 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 ha terminado el procesamiento.

Los datasets son colecciones de datatables relacionados que pertenecen lógicamente al mismo conjunto.

Listar datasets

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 datasets

[
	{
		"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 dataset (con un datatable vacío)

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

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

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string 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):

Dataset 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á desactivada o ha caducado

Obtener un dataset

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

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

Parámetros:

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

Respuesta (200):

Dataset

{
	"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á desactivada o ha caducado
  • 404 Recurso no encontrado

Eliminar un dataset de forma lógica

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

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

Parámetros:

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

Respuesta (200):

Dataset 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á desactivada o ha caducado
  • 404 Recurso no encontrado

Listar los datatables de un dataset

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 datatables del dataset

[
	{
		"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á desactivada o ha caducado
  • 404 Recurso no encontrado

Crear un datatable vacío dentro de un dataset

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 del datatable
Longitud máxima: 128

Respuesta (201):

Datatable creado

{
	"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á desactivada o ha caducado
  • 404 Recurso no encontrado

Los datatables almacenan los datos reales del registro de eventos utilizados para Process Mining.

Listar datatables

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 datatables

[
	{
		"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á desactivada o ha caducado

Obtener un datatable

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

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

Parámetros:

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

Respuesta (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"
	}
}
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á desactivada o ha caducado
  • 404 Recurso no encontrado

Actualizar un datatable (displayName, parseSettings, …)

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 del datatable
Longitud máxima: 128
filterExpression string No Expresión de filtro aplicada a los datos
Longitud máxima: 4096

Respuesta (200):

Datatable actualizado

{
	"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á desactivada o ha caducado
  • 404 Recurso no encontrado

Obtener una URL presignada para descargar el archivo de origen del datatable

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 la falta de un campo obligatorio
  • 401 Falta la clave de API, no es válida, está desactivada o ha caducado
  • 404 Recurso no encontrado

Cancelar una carga multiparte y descartar las partes cargadas

Requiere el ámbito uploadData en la clave de API.

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 por 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á desactivada o ha caducado
  • 403 La clave de API no tiene el ámbito requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado

Completar una carga multiparte (paso 3 de 3)

Requiere el ámbito uploadData en la clave de API. Ensambla las partes cargadas (mediante sus ETags) y activa el procesamiento del registro de eventos.

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 por 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á desactivada o ha caducado
  • 403 La clave de API no tiene el ámbito requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado

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

Requiere el ámbito uploadData en la clave de API. Devuelve un uploadId y un uploadHandle opaco que se deben enviar 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 asociada al inquilino · ámbito 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 que se presignarán (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á desactivada o ha caducado
  • 403 La clave de API no tiene el ámbito requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado

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

Requiere el ámbito uploadData en la clave de API. Devuelve una URL PUT presignada por cada número de parte solicitado.

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 por el paso de inicio
partNumbers number[] Sí

Respuesta (200):

URL presignadas 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á desactivada o ha caducado
  • 403 La clave de API no tiene el ámbito requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado

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

Requiere el ámbito uploadData en la clave de API, independientemente de read/write. El filesize declarado (en bytes) se comprueba con respecto al tamaño máximo de carga del plan; el tamaño real del objeto se vuelve a verificar cuando llega el archivo.

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

Autenticación: Clave de API asociada al inquilino · ámbito 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 con respecto al tamaño máximo de carga del plan)
filelastmodified string consulta Sí
datasetid string consulta No Obligatorio para cargas completas (no delta)
modelid string consulta No Formato: uuid
delta true | false consulta No Valores permitidos: true, false
partnumber string consulta No
validforseconds integer consulta No Duración de la URL presignada en segundos (1–3600, valor predeterminado: 3600)

Respuesta (200):

URL presignada

{
	"PreSignedUploadUrl": "string"
}
Campo Tipo Obligatorio Descripción
PreSignedUploadUrl string Sí URL PUT de S3 presignada (válida durante aproximadamente 1 hora)

Errores:

  • 401 Falta la clave de API, no es válida, está desactivada o ha caducado
  • 403 La clave de API no tiene el ámbito requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado
  • 413 El archivo supera el tamaño máximo de carga del plan

Documentación relacionada