Lista de Documentos
Nesta Página

Referência da API: Data

Endpoints de Dataset

Datasets são conjuntos de datatables relacionados que fazem parte de um mesmo contexto de dados.

Listar Datasets

Veja todos os datasets do tenant.

Endpoint: GET /tenant/{tenantId}/datasets

Parâmetros:

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSimIdentificador único do tenant

Resposta:

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

Criar Dataset

Crie um novo dataset em um tenant.

Endpoint: POST /tenant/{tenantId}/datasets

Parâmetros:

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSimIdentificador único do tenant

Request Body:

{
	"displayName": "My New Dataset",
	"treeNodeType": "Dataset",
	"treeParentId": null
}
CampoTipoObrigatórioDescrição
displayNamestringSimNome do dataset
treeNodeTypestringNãoDeve ser Dataset (padrão) ou TreeGroup
treeParentIdstringNãoID da pasta pai para organizar os datasets

Resposta: Retorna o objeto do dataset criado.


Obter Dataset

Recupere detalhes de um dataset específico.

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

Parâmetros:

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSimIdentificador único do tenant
datasetIdstringpathSimIdentificador único do dataset

Resposta:

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

Excluir Dataset

Exclua um dataset e todas as suas datatables.

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

Parâmetros:

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSimIdentificador único do tenant
datasetIdstringpathSimIdentificador único do dataset

Resposta:

{
	"success": true
}

warning

A exclusão de um dataset remove de forma permanente todas as datatables e dados associados. Esta ação não pode ser desfeita.


Endpoints de Datatable

Datatables armazenam os dados reais de event log usados para Process Mining.

Listar Datatables

Veja todas as datatables do tenant.

Endpoint: GET /tenant/{tenantId}/datatables

Parâmetros:

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSimIdentificador único do tenant

Resposta:

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

Criar Datatable

Crie uma nova datatable dentro de um dataset existente.

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

Parâmetros:

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSimIdentificador único do tenant
datasetIdstringpathSimIdentificador único do dataset

Request Body:

{
	"displayName": "Orders Q1 2024"
}
CampoTipoObrigatórioDescrição
displayNamestringSimNome da datatable

Resposta: Retorna o objeto da datatable criada.


Obter Datatable

Recupere detalhes de uma datatable específica.

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

Parâmetros:

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSimIdentificador único do tenant
datatableIdstringpathSimIdentificador único da datatable

Resposta:

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

Obter URL Pre-assinada de Upload

Gere uma URL temporária para enviar um arquivo direto para uma datatable.

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

Parâmetros:

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSimIdentificador único do tenant
datatableIdstringpathSimIdentificador único da datatable
datasetidstringquerySimIdentificador único do dataset
filenamestringquerySimNome do arquivo para upload
filesizestringquerySimTamanho do arquivo em bytes
filelastmodifiedstringquerySimData da última modificação do arquivo
validforsecondsstringqueryNãoValidade da URL em segundos (padrão: 3600)

Resposta:

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

Uso: Use a URL retornada para enviar o arquivo via HTTP PUT:

# Obtenha a URL pre-assinada com os parâmetros necessários
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")

# Envie o arquivo
curl -X PUT --upload-file "data.csv" -H "Content-Type: text/csv" "$URL"

info

URLs pre-assinadas expiram após um tempo limitado. Use a URL logo após gerá-la. Se o upload falhar, solicite uma nova URL pre-assinada.