Nesta página

> recursos > documentação > api > Referência da API: dados

Referência da API: dados

warning

Excluir um conjunto de dados removerá permanentemente todas as tabelas de dados e os dados associados. Essa ação não pode ser desfeita.

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

As URLs pré-assinadas expiram após um período limitado. Use a URL logo após obtê-la. Se o carregamento falhar, solicite uma nova URL pré-assinada.

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

Nas tabelas de dados carregadas, o formato do arquivo original é preservado (CSV, Parquet, ORC, JSONL ou Excel). Os resultados de simulação são sempre arquivos 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

A tabela de dados precisa ter dados iniciais carregados antes que seja possível enviar atualizações incrementais. O arquivo incremental deve usar o mesmo formato do arquivo original, por exemplo, um arquivo CSV incremental para um original CSV, ou Parquet para Parquet, e ter a mesma estrutura de colunas. Não há suporte para arquivos Excel e XES em atualizações incrementais.

info

Depois do carregamento pela URL pré-assinada, o ProcessMind processa automaticamente os dados incrementais e os combina com os dados originais. Consulte GET /datatables/{dataTableId} até que hasDataLoaded seja true para saber quando o processamento terminar.

Os conjuntos de dados reúnem tabelas de dados relacionadas que pertencem ao mesmo contexto lógico.

Listar conjuntos de dados

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

Autenticação: chave de API com escopo de ambiente · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
limit	integer	consulta	Não	Número máximo de itens a retornar
offset	integer	consulta	Não	Número de itens a ignorar

Resposta (200):

Lista de conjuntos de dados

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

Erros:

401 Chave de API ausente, inválida, desativada ou expirada

Criar um conjunto de dados (com uma tabela de dados vazia)

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

Autenticação: chave de API com escopo de ambiente · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
displayName	string	Sim	Nome do conjunto de dados exibido na árvore de dados Comprimento máximo: 128
treeParentId	string	Não	ID da pasta pai (null = nível superior) Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Não	Conjunto de dados ou pasta Valores permitidos: `Dataset`, `TreeGroup` Padrão: `Dataset`

Resposta (201):

Dataset criado

{
	"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	Obrigatório	Descrição
id	string	Sim	Formato: `uuid`
treeParentId	string	Sim	Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Sim	Valores permitidos: `Dataset`, `TreeGroup` Padrão: `Dataset`
displayName	string	Sim	Padrão: `""` Comprimento máximo: 128
createdAt	string	Sim	Formato: `date-time`
updatedAt	string	Sim	Formato: `date-time`
dataTableId	string	Sim	Formato: `uuid`

Erros:

401 Chave de API ausente, inválida, desativada ou expirada

Consultar um Dataset

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

Autenticação: Chave de API vinculada ao ambiente · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
datasetId	string	caminho	Sim	Formato: `uuid`

Resposta (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	Obrigatório	Descrição
id	string	Sim	Formato: `uuid`
treeParentId	string	Sim	Formato: `uuid`
treeNodeType	`Dataset` \| `TreeGroup`	Sim	Valores permitidos: `Dataset`, `TreeGroup` Padrão: `Dataset`
displayName	string	Sim	Padrão: `""` Comprimento máximo: 128
createdAt	string	Sim	Formato: `date-time`
updatedAt	string	Sim	Formato: `date-time`
dataTableId	string	Sim	Formato: `uuid`

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
404 Recurso não encontrado

Excluir um Dataset logicamente

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

Autenticação: Chave de API vinculada ao ambiente · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
datasetId	string	caminho	Sim	Formato: `uuid`

Resposta (200):

Dataset excluído

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

Campo	Tipo	Obrigatório	Descrição
success	boolean	Sim
message	string	Sim

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
404 Recurso não encontrado

Listar as tabelas de dados de um Dataset

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

Autenticação: Chave de API vinculada ao ambiente · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
datasetId	string	caminho	Sim	Formato: `uuid`
limit	integer	consulta	Não	Número máximo de itens a retornar
offset	integer	consulta	Não	Número de itens a ignorar

Resposta (200):

Lista de tabelas de dados do 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"
		}
	}
]

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
404 Recurso não encontrado

Criar uma tabela de dados vazia dentro de um Dataset

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

Autenticação: Chave de API vinculada ao ambiente · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
datasetId	string	caminho	Sim	Formato: `uuid`

Corpo da solicitação:

{
	"displayName": "string"
}

Campo	Tipo	Obrigatório	Descrição
displayName	string	Sim	Nome da tabela de dados Comprimento máximo: 128

Resposta (201):

Tabela de dados criada

{
	"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	Obrigatório	Descrição
id	string	Sim	Formato: `uuid`
datasetId	string	Sim	Formato: `uuid`
displayName	string	Sim	Padrão: `""` Comprimento máximo: 128
createdAt	string	Sim	Formato: `date-time`
updatedAt	string	Sim	Formato: `date-time`
hasDataLoaded	boolean	Sim	Padrão: `false`
filterExpression	string	Sim	Comprimento máximo: 4096
metaInfo	object \| object \| object \| object	Sim

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
404 Recurso não encontrado

As tabelas de dados armazenam os dados do Event Log usados no Process Mining.

Listar tabelas de dados

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

Autenticação: Chave de API vinculada ao ambiente · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
limit	integer	consulta	Não	Número máximo de itens a retornar
offset	integer	consulta	Não	Número de itens a ignorar

Resposta (200):

Lista de tabelas de dados

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

Erros:

401 Chave de API ausente, inválida, desativada ou expirada

Consultar uma tabela de dados

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

Autenticação: Chave de API vinculada ao ambiente · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
dataTableId	string	caminho	Sim	Formato: `uuid`

Resposta (200):

Tabela de dados

{
	"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	Obrigatório	Descrição
id	string	Sim	Formato: `uuid`
datasetId	string	Sim	Formato: `uuid`
displayName	string	Sim	Padrão: `""` Comprimento máximo: 128
createdAt	string	Sim	Formato: `date-time`
updatedAt	string	Sim	Formato: `date-time`
hasDataLoaded	boolean	Sim	Padrão: `false`
filterExpression	string	Sim	Comprimento máximo: 4096
metaInfo	object \| object \| object \| object	Sim

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
404 Recurso não encontrado

Atualizar uma tabela de dados (displayName, parseSettings, …)

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

Autenticação: Chave de API vinculada ao ambiente · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
dataTableId	string	caminho	Sim	Formato: `uuid`

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
displayName	string	Não	Nome da tabela de dados Comprimento máximo: 128
filterExpression	string	Não	Expressão de filtro aplicada aos dados Comprimento máximo: 4096

Resposta (200):

Tabela de dados atualizada

{
	"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	Obrigatório	Descrição
id	string	Sim	Formato: `uuid`
datasetId	string	Sim	Formato: `uuid`
displayName	string	Sim	Padrão: `""` Comprimento máximo: 128
createdAt	string	Sim	Formato: `date-time`
updatedAt	string	Sim	Formato: `date-time`
hasDataLoaded	boolean	Sim	Padrão: `false`
filterExpression	string	Sim	Comprimento máximo: 4096
metaInfo	object \| object \| object \| object	Sim

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
404 Recurso não encontrado

Obter uma URL pré-assinada para baixar o arquivo de origem da tabela de dados

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

Autenticação: Chave de API vinculada ao ambiente · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
dataTableId	string	caminho	Sim	Formato: `uuid`

Resposta (200):

URL de download

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

Campo	Tipo	Obrigatório	Descrição
downloadUrl	string	Sim
expiresInSeconds	number	Sim

Erros:

400 Solicitação inválida: por exemplo, expressão de filtro inválida, processo sem modelo, tipo de arquivo não compatível ou campo obrigatório ausente
401 Chave de API ausente, inválida, desativada ou expirada
404 Recurso não encontrado

Cancelar um upload multipart e descartar as partes enviadas

Requer o escopo uploadData na chave de API.

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

Autenticação: Chave de API vinculada ao ambiente · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
dataTableId	string	caminho	Sim	Formato: `uuid`

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
uploadId	string	Sim
uploadHandle	string	Sim	Identificador opaco retornado na etapa de inicialização

Resposta (200):

Upload cancelado

{
	"message": "string"
}

Campo	Tipo	Obrigatório	Descrição
message	string	Sim

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
403 A chave de API não tem o escopo necessário ou acesso à organização, o ambiente está inativo ou o plano não permite esse tipo de arquivo
404 Recurso não encontrado

Concluir um upload multipart (etapa 3 de 3)

Requer o escopo uploadData na chave de API. Reúne as partes enviadas (usando seus ETags) e inicia o processamento do Event Log.

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

Autenticação: Chave de API vinculada ao ambiente · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
dataTableId	string	caminho	Sim	Formato: `uuid`

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
uploadId	string	Sim
uploadHandle	string	Sim	Identificador opaco retornado na etapa de inicialização
parts	object[]	Sim

Resposta (200):

Concluído ({ completed: true })

{
	"message": "string"
}

Campo	Tipo	Obrigatório	Descrição
message	string	Sim

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
403 A chave de API não tem o escopo necessário ou acesso à organização, o ambiente está inativo ou o plano não permite esse tipo de arquivo
404 Recurso não encontrado

Iniciar um upload multipart (em partes) dos dados do Event Log (etapa 1 de 3)

Requer o escopo uploadData na chave de API. Retorna um uploadId e um uploadHandle opaco para usar nas chamadas seguintes parts, complete e abort. Indicado para arquivos grandes.

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

Autenticação: Chave de API vinculada ao ambiente · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
dataTableId	string	caminho	Sim	Formato: `uuid`

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
fileName	string	Sim
fileSize	number	Sim
fileLastModified	number	Sim
partCount	number	Não	Número de partes para as quais gerar URLs pré-assinadas (padrão: 10)
delta	boolean	Não	Indica se o upload é incremental (delta)
datasetId	string	Não	Formato: `uuid`
modelId	string	Não	Formato: `uuid`

Resposta (200):

Upload iniciado

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

Campo	Tipo	Obrigatório	Descrição
uploadId	string	Não
uploadHandle	string	Não	Identificador opaco para as etapas de envio das partes, conclusão e cancelamento
partCount	number	Não
partSizeBytes	number	Não

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
403 A chave de API não tem o escopo necessário ou acesso à organização, o ambiente está inativo ou o plano não permite esse tipo de arquivo
404 Recurso não encontrado

Obter URLs pré-assinadas para as partes de um upload multipart (etapa 2 de 3)

Requer o escopo uploadData na chave de API. Retorna uma URL PUT pré-assinada para cada número de parte solicitado.

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

Autenticação: Chave de API vinculada ao ambiente · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
dataTableId	string	caminho	Sim	Formato: `uuid`

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
uploadId	string	Sim
uploadHandle	string	Sim	Identificador opaco retornado na etapa de inicialização
partNumbers	number[]	Sim

Resposta (200):

URLs pré-assinadas das partes ({ uploadId, parts: [{ partNumber, url }] })

{
	"message": "string"
}

Campo	Tipo	Obrigatório	Descrição
message	string	Sim

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
403 A chave de API não tem o escopo necessário ou acesso à organização, o ambiente está inativo ou o plano não permite esse tipo de arquivo
404 Recurso não encontrado

Obter uma URL de upload S3 pré-assinada para os dados do Event Log (CSV/XLSX, completo ou incremental)

Requer o escopo uploadData na chave de API (independentemente de leitura ou gravação). O filesize declarado (em bytes) é comparado ao tamanho máximo de upload do plano; o tamanho real do objeto é verificado novamente quando o arquivo chega.

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

Autenticação: Chave de API vinculada ao ambiente · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: `uuid`
dataTableId	string	caminho	Sim	Formato: `uuid`
filename	string	consulta	Sim
filesize	string	consulta	Sim	Tamanho do arquivo em bytes (comparado ao tamanho máximo de upload do plano)
filelastmodified	string	consulta	Sim
datasetid	string	consulta	Não	Obrigatório para uploads completos (não incrementais)
modelid	string	consulta	Não	Formato: `uuid`
delta	`true` \| `false`	consulta	Não	Valores permitidos: `true`, `false`
partnumber	string	consulta	Não
validforseconds	integer	consulta	Não	Validade da URL pré-assinada em segundos (1–3600, padrão: 3600)

Resposta (200):

URL pré-assinada

{
	"PreSignedUploadUrl": "string"
}

Campo	Tipo	Obrigatório	Descrição
PreSignedUploadUrl	string	Sim	URL PUT pré-assinada do S3 (válida por cerca de 1 hora)

Erros:

401 Chave de API ausente, inválida, desativada ou expirada
403 A chave de API não tem o escopo necessário ou acesso à organização, o ambiente está inativo ou o plano não permite esse tipo de arquivo
404 Recurso não encontrado
413 O arquivo excede o tamanho máximo de upload do plano

Documentação relacionada

Referência da API: organizações

Referência da API para endpoints de gerenciamento de organizações e administração de usuários.

Referência da API: ambientes

Referência da API para endpoints de gerenciamento de ambientes e controle de acesso de usuários.

Referência da API: processos

Referência da API para endpoints de gerenciamento de processos e mapeamento de dados.

Referência da API: simulações

Referência da API para endpoints de gerenciamento de simulações e geração com IA.

Referência da API: dados

Listar conjuntos de dados

Criar um conjunto de dados (com uma tabela de dados vazia)

Consultar um Dataset

Excluir um Dataset logicamente

Listar as tabelas de dados de um Dataset

Criar uma tabela de dados vazia dentro de um Dataset

Listar tabelas de dados

Consultar uma tabela de dados

Atualizar uma tabela de dados (displayName, parseSettings, …)

Obter uma URL pré-assinada para baixar o arquivo de origem da tabela de dados

Cancelar um upload multipart e descartar as partes enviadas

Concluir um upload multipart (etapa 3 de 3)

Iniciar um upload multipart (em partes) dos dados do Event Log (etapa 1 de 3)

Obter URLs pré-assinadas para as partes de um upload multipart (etapa 2 de 3)

Obter uma URL de upload S3 pré-assinada para os dados do Event Log (CSV/XLSX, completo ou incremental)

Documentação relacionada

Referência da API: organizações

Referência da API: ambientes

Referência da API: processos

Referência da API: simulações

Sua privacidade é importante para nós