API Referência: Processos

Endpoints de Process

Listar Processes

Recupere todos os processes de um tenant.

Endpoint: GET /tenant/{tenantId}/processes

Parâmetros:

Resposta:

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

Criar Process

Crie um novo process dentro de um tenant.

Endpoint: POST /tenant/{tenantId}/processes

Parâmetros:

Request Body:

{
	"displayName": "Meu Novo Process",
	"treeNodeType": "Process",
	"treeParentId": null
}

Resposta: Retorna o objeto do process criado.

Get Process

Recupere detalhes de um process específico.

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

Parâmetros:

Resposta:

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

Atualizar Process

Atualize um process (renomeie ou mova para uma pasta diferente).

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

Parâmetros:

Request Body:

{
	"displayName": "Nome Atualizado do Process",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}

Resposta: Retorna o objeto do process atualizado.

Deletar Process

Exclua um process e todos os dados associados.

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

Parâmetros:

Resposta:

{
	"success": true
}

Upload BPMN

Faça upload de um arquivo BPMN XML para definir ou atualizar um modelo de process.

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

Parâmetros:

Request Body:

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

Resposta: Retorna o objeto do process atualizado com o novo modelo.

Endpoints de Process Data Mapping

Os data mappings conectam datatables aos processos, permitindo visualizar e analisar seus dados de event log em um modelo de process.

Listar Process Mappings

Recupere todos os data mappings de um process.

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

Parâmetros:

Resposta:

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

Criar Process Mapping

Adicione um data table mapping a um process.

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

Parâmetros:

Request Body:

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

Resposta: Retorna o objeto mapping criado.

Atualizar Process Mapping

Atualize as configurações de exibição de um data mapping já existente.

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

Parâmetros:

Request Body:

{
	"displayName": "Nome Atualizado",
	"color": { "id": "data-2" },
	"showByDefault": false
}

Resposta: Retorna o objeto mapping atualizado.

Deletar Process Mapping

Remova um data mapping de um process.

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

Parâmetros:

Resposta:

{
	"success": true
}