Referencia API: Procesos

Endpoints de procesos

Listar procesos

Consulta todos los procesos dentro de un tenant.

Endpoint: GET /tenant/{tenantId}/processes

Parámetros:

Respuesta:

[
	{
		"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
		"displayName": "Order to Cash",
		"treeNodeType": "Process",
		"treeParentId": null,
		"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"createdAt": "2024-03-01T09:00:00Z",
		"updatedAt": "2024-03-15T16:30:00Z"
	}
]

Crear proceso

Crea un nuevo proceso dentro de un tenant.

Endpoint: POST /tenant/{tenantId}/processes

Parámetros:

Cuerpo de la petición:

{
	"displayName": "Mi nuevo proceso",
	"treeNodeType": "Process",
	"treeParentId": null
}

Respuesta: Devuelve el objeto del proceso creado.

Obtener proceso

Consulta detalles de un proceso específico.

Endpoint: GET /tenant/{tenantId}/processes/{processId}

Parámetros:

Respuesta:

{
	"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
	"displayName": "Order to Cash",
	"treeNodeType": "Process",
	"treeParentId": null,
	"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
	"createdAt": "2024-03-01T09:00:00Z",
	"updatedAt": "2024-03-15T16:30:00Z"
}

Actualizar proceso

Actualiza un proceso (cambia el nombre o muévelo a otra carpeta).

Endpoint: PUT /tenant/{tenantId}/processes/{processId}

Parámetros:

Cuerpo de la petición:

{
	"displayName": "Nuevo nombre de proceso",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}

Respuesta: Devuelve el objeto del proceso actualizado.

Eliminar proceso

Elimina un proceso y sus datos asociados.

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}

Parámetros:

Respuesta:

{
	"success": true
}

Subir BPMN

Sube un archivo BPMN XML para definir o actualizar un modelo de proceso.

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/bpmn

Parámetros:

Cuerpo de la petición:

{
	"bpmnXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}

Respuesta: Devuelve el objeto de proceso actualizado con el nuevo modelo.

Endpoints de mapeo de data de procesos

Los data mappings conectan datatables con procesos, permitiendo visualizar y analizar tus datos de event log en un modelo de proceso.

Listar mapeos de proceso

Consulta todos los data mappings de un proceso.

Endpoint: GET /tenant/{tenantId}/processes/{processId}/mappings

Parámetros:

Respuesta:

[
	{
		"id": "e1f2a3b4-c5d6-7890-efa1-234567890123",
		"modelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Sales Data 2024",
		"color": { "id": "data-1" },
		"showByDefault": true,
		"createdAt": "2024-03-10T11:00:00Z"
	}
]

Crear mapeo de proceso

Agrega un data table mapping a un proceso.

Endpoint: POST /tenant/{tenantId}/processes/{processId}/mappings

Parámetros:

Cuerpo de la petición:

{
	"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Sales Data 2024",
	"color": { "id": "data-1" },
	"showByDefault": true
}

Respuesta: Devuelve el objeto mapping creado.

Actualizar mapeo de proceso

Actualiza las opciones de visualización de un data mapping existente.

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Parámetros:

Cuerpo de la petición:

{
	"displayName": "Nombre actualizado",
	"color": { "id": "data-2" },
	"showByDefault": false
}

Respuesta: Devuelve el objeto mapping actualizado.

Eliminar mapeo de proceso

Elimina un data mapping de un proceso.

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Parámetros:

Respuesta:

{
	"success": true
}