Referência de API: Organizações
Referência de API para endpoints de gestão de organizações e administração de usuários.
Datasets são conjuntos de datatables relacionados que fazem parte de um mesmo contexto de dados.
Veja todos os datasets do tenant.
Endpoint: GET /tenant/{tenantId}/datasets
Parâmetros:
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | Identificador único do tenant |
Resposta:
[
{
"id": "f6a7b8c9-d0e1-2345-fab6-789012345678",
"displayName": "Sales Data",
"createdAt": "2024-01-20T08:00:00Z",
"datatableCount": 3
}
]
Crie um novo dataset em um tenant.
Endpoint: POST /tenant/{tenantId}/datasets
Parâmetros:
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | Identificador único do tenant |
Request Body:
{
"displayName": "My New Dataset",
"treeNodeType": "Dataset",
"treeParentId": null
}
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| displayName | string | Sim | Nome do dataset |
| treeNodeType | string | Não | Deve ser Dataset (padrão) ou TreeGroup |
| treeParentId | string | Não | ID da pasta pai para organizar os datasets |
Resposta: Retorna o objeto do dataset criado.
Recupere detalhes de um dataset específico.
Endpoint: GET /tenant/{tenantId}/datasets/{datasetId}
Parâmetros:
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | Identificador único do tenant |
| datasetId | string | path | Sim | Identificador ú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
}
]
}
Exclua um dataset e todas as suas datatables.
Endpoint: DELETE /tenant/{tenantId}/datasets/{datasetId}
Parâmetros:
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | Identificador único do tenant |
| datasetId | string | path | Sim | Identificador ú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.
Datatables armazenam os dados reais de event log usados para Process Mining.
Veja todas as datatables do tenant.
Endpoint: GET /tenant/{tenantId}/datatables
Parâmetros:
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | Identificador ú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"
}
]
Crie uma nova datatable dentro de um dataset existente.
Endpoint: POST /tenant/{tenantId}/datasets/{datasetId}/datatables
Parâmetros:
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | Identificador único do tenant |
| datasetId | string | path | Sim | Identificador único do dataset |
Request Body:
{
"displayName": "Orders Q1 2024"
}
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| displayName | string | Sim | Nome da datatable |
Resposta: Retorna o objeto da datatable criada.
Recupere detalhes de uma datatable específica.
Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}
Parâmetros:
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | Identificador único do tenant |
| datatableId | string | path | Sim | Identificador ú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"
}
Gere uma URL temporária para enviar um arquivo direto para uma datatable.
Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl
Parâmetros:
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | Identificador único do tenant |
| datatableId | string | path | Sim | Identificador único da datatable |
| datasetid | string | query | Sim | Identificador único do dataset |
| filename | string | query | Sim | Nome do arquivo para upload |
| filesize | string | query | Sim | Tamanho do arquivo em bytes |
| filelastmodified | string | query | Sim | Data da última modificação do arquivo |
| validforseconds | string | query | Não | Validade 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.