Referência da API: processos

Listar processos

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

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 processos

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Process",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"designerModelId": "00000000-0000-0000-0000-000000000000"
	}
]

Erros:

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

Criar um processo (com um modelo vazio)

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

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": "Process"
}

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

Resposta (201):

Processo criado

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
treeParentId	string	Sim	Formato: uuid
treeNodeType	Process | TreeGroup	Sim	Valores permitidos: Process, TreeGroup Padrão: Process
displayName	string	Sim	Padrão: New Process Comprimento máximo: 128
createdAt	string	Sim	Formato: date-time
updatedAt	string	Sim	Formato: date-time
designerModelId	string	Sim	Formato: uuid

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 500 Erro inesperado do servidor: a solicitação pode ser repetida com segurança

Obter um processo

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

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
processId	string	caminho	Sim	Formato: uuid

Resposta (200):

Processo

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
treeParentId	string	Sim	Formato: uuid
treeNodeType	Process | TreeGroup	Sim	Valores permitidos: Process, TreeGroup Padrão: Process
displayName	string	Sim	Padrão: New Process Comprimento máximo: 128
createdAt	string	Sim	Formato: date-time
updatedAt	string	Sim	Formato: date-time
designerModelId	string	Sim	Formato: uuid

Erros:

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

Atualizar um processo

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

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
processId	string	caminho	Sim	Formato: uuid

Corpo da solicitação:

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

Campo	Tipo	Obrigatório	Descrição
displayName	string	Não	Nome do processo exibido na árvore de processos Comprimento máximo: 128
treeParentId	string	Não	ID da pasta pai (null = nível superior) Formato: uuid

Resposta (200):

Processo atualizado

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
treeParentId	string	Sim	Formato: uuid
treeNodeType	Process | TreeGroup	Sim	Valores permitidos: Process, TreeGroup Padrão: Process
displayName	string	Sim	Padrão: New Process Comprimento máximo: 128
createdAt	string	Sim	Formato: date-time
updatedAt	string	Sim	Formato: date-time
designerModelId	string	Sim	Formato: uuid

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 404 Recurso não encontrado
• 500 Erro inesperado do servidor: a solicitação pode ser repetida com segurança

Excluir logicamente um processo

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

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
processId	string	caminho	Sim	Formato: uuid

Resposta (200):

Processo 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

Exportar o modelo do processo como XML BPMN 2.0

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

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
processId	string	caminho	Sim	Formato: uuid

Resposta (200):

XML BPMN

{
	"bpmnXml": "string"
}

Campo	Tipo	Obrigatório	Descrição
bpmnXml	string	Sim	XML BPMN 2.0

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 404 Recurso não encontrado
• 500 Erro inesperado do servidor: a solicitação pode ser repetida com segurança

Importar um modelo BPMN 2.0 para o processo (substitui o modelo atual)

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

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
processId	string	caminho	Sim	Formato: uuid

Corpo da solicitação:

{
	"bpmnXml": "string"
}

Campo	Tipo	Obrigatório	Descrição
bpmnXml	string	Sim	XML BPMN 2.0

Resposta (200):

BPMN carregado

{
	"message": "string"
}

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

Erros:

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

Os mapeamentos de dados conectam tabelas de dados a processos, permitindo visualizar e analisar os dados do seu Event Log em um modelo de processo.

Listar mapeamentos de dados de um processo

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

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
processId	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 mapeamentos

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

Erros:

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

Mapear uma tabela de dados para o processo (inicia o processamento do Event Log)

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

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

Parâmetros:

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

Corpo da solicitação:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}

Campo	Tipo	Obrigatório	Descrição
dataTableId	string	Sim	Datatable a ser mapeada para o processo Formato: uuid
displayName	string	Não	Nome de exibição do mapeamento Comprimento máximo: 128
color	object	Não	Cor de destaque
showByDefault	boolean	Não	Exibir este mapeamento por padrão na visualização do processo Padrão: true
mappingRole	primary | comparison	Não	Função dos dados mapeados no modelo Valores permitidos: primary, comparison

Resposta (201):

Mapeamento criado

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
modelId	string	Sim	Formato: uuid
dataTableId	string	Sim	Formato: uuid
displayName	string	Sim	Comprimento máximo: 128
color	object	Sim
showByDefault	boolean	Sim	Padrão: true
mappingRole	primary | comparison	Sim	Valores permitidos: primary, comparison Padrão: comparison
sortOrder	integer	Sim	Padrão: 0 Mínimo: -9007199254740991 Máximo: 9007199254740991

Erros:

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

Atualizar um mapeamento

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

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

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim	Formato: uuid
processId	string	path	Sim	Formato: uuid
mappingId	string	path	Sim	Formato: uuid

Corpo da solicitação:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Campo	Tipo	Obrigatório	Descrição
displayName	string	Não	Comprimento máximo: 128
color	object	Não
showByDefault	boolean	Não
mappingRole	primary | comparison	Não	Valores permitidos: primary, comparison
sortOrder	integer	Não	Mínimo: -9007199254740991 Máximo: 9007199254740991

Resposta (200):

Mapeamento atualizado

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
modelId	string	Sim	Formato: uuid
dataTableId	string	Sim	Formato: uuid
displayName	string	Sim	Comprimento máximo: 128
color	object	Sim
showByDefault	boolean	Sim	Padrão: true
mappingRole	primary | comparison	Sim	Valores permitidos: primary, comparison Padrão: comparison
sortOrder	integer	Sim	Padrão: 0 Mínimo: -9007199254740991 Máximo: 9007199254740991

Erros:

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

Excluir um mapeamento

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

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

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim	Formato: uuid
processId	string	path	Sim	Formato: uuid
mappingId	string	path	Sim	Formato: uuid

Resposta (200):

Mapeamento excluído

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

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

Erros:

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

Estes endpoints usam IA para gerar automaticamente modelos de processos BPMN a partir de descrições em linguagem natural.

Gerar um modelo de processo a partir de um prompt em linguagem natural (assíncrono; consulte o endpoint de status)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Autenticação: Chave de API com escopo do ambiente · escopo write · limite de taxa de 2 req/s (rajada de 4)

Parâmetros:

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

Corpo da solicitação:

{
	"prompt": "string"
}

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

Resposta (200):

Geração iniciada / resultado

{
	"message": "string"
}

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

Erros:

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

Consultar o status da geração do modelo

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

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

Parâmetros:

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

Resposta (200):

Status da geração

{
	"message": "string"
}

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

Erros:

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

As métricas por caso do modelo mais recente do processo: uma linha por caso com a sequência calculada e as métricas de saúde.

Obter métricas por caso de um processo (modelo mais recente, paginado)

Retorna uma linha por caso com as métricas calculadas do processo (duração, comprimento, Conformidade, retrabalho, pontuação de saúde, variante, entre outras) para o modelo mais recente do processo. Nenhum filtro de linhas é aplicado. O resultado é paginado: use limit (padrão 1000, máximo 10000) e offset, continuando a paginação enquanto hasMore for verdadeiro. Enquanto as métricas ainda estiverem sendo calculadas, a resposta terá o estado preprocessing.

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

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

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim	Formato: uuid
processId	string	path	Sim	Formato: uuid
limit	integer	query	Não	Número máximo de linhas de casos a retornar (padrão 1000, máximo 10000)
offset	integer	query	Não	Número de linhas de casos a ignorar (padrão 0)

Resposta (200):

Métricas dos casos

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

Erros:

• 400 Solicitação inválida: por exemplo, uma expressão de filtro inválida, um processo sem modelo, um tipo de upload não compatível ou um campo obrigatório ausente
• 401 Chave de API ausente, inválida, desativada ou expirada
• 404 Recurso não encontrado
• 503 Pipeline de dados não está pronto ou uma consulta upstream falhou

Listar versões do processo

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

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

Parâmetros:

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

Resposta (200):

Lista de versões

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

Erros:

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

Criar um instantâneo de versão do processo

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/versions

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

Parâmetros:

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

Corpo da solicitação:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obrigatório	Descrição
displayName	string	Não	Rótulo da versão Padrão: "" Comprimento máximo: 128
description	string	Não	Descrição opcional da versão
versionType	manual | auto	Não	manual = criada pelo usuário, auto = criada pelo sistema Valores permitidos: manual, auto
restoreFromVersionId	string	Não	Versão a partir da qual restaurar ao criar este instantâneo Formato: uuid

Resposta (201):

Versão criada

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Campo	Tipo	Obrigatório	Descrição
version	object	Sim
restoredFrom	object	Sim

Erros:

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

Obter uma versão do processo

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

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

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim	Formato: uuid
processId	string	path	Sim	Formato: uuid
versionId	string	path	Sim	Formato: uuid

Resposta (200):

Versão

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Campo	Tipo	Obrigatório	Descrição
version	object	Sim

Erros:

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

Renomear ou atualizar uma versão do processo

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

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

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim	Formato: uuid
processId	string	path	Sim	Formato: uuid
versionId	string	path	Sim	Formato: uuid

Corpo da solicitação:

{
	"displayName": "string",
	"description": "string"
}

Campo	Tipo	Obrigatório	Descrição
displayName	string	Não	Rótulo da versão Comprimento máximo: 128
description	string	Não	Descrição opcional da versão

Resposta (200):

Versão atualizada

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Campo	Tipo	Obrigatório	Descrição
version	object	Sim

Erros:

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

Excluir uma versão do processo

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

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

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim	Formato: uuid
processId	string	path	Sim	Formato: uuid
versionId	string	path	Sim	Formato: uuid

Resposta (200):

Versão excluída

{
	"deleted": true
}

Campo	Tipo	Obrigatório	Descrição
deleted	boolean	Sim

Erros:

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

Obter um artefato

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

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

Parâmetros:

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

Resposta (200):

Artefato

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
displayName	string	Sim	Padrão: "" Comprimento máximo: 500
description	string	Sim	Comprimento máximo: 2000
originalFileName	string	Sim	Padrão: "" Comprimento máximo: 500
mimeType	string	Sim	Padrão: "" Comprimento máximo: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Sim	Valores permitidos: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Sim	Valores permitidos: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Padrão: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Sim	Valores permitidos: Uploading, Ready, Failed, Deleted Padrão: Uploading
hasThumbnail	boolean	Sim	Padrão: false
sizeBytes	number	Sim	Padrão: 0
createdAt	string	Sim	Formato: date-time
createdBy	string	Não	Formato: uuid

Erros:

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

Atualizar o nome de exibição ou a descrição de um artefato

Endpoint: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

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

Parâmetros:

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

Corpo da solicitação:

{
	"displayName": "string",
	"description": "string"
}

Campo	Tipo	Obrigatório	Descrição
displayName	string	Não	Nome do artefato Comprimento máximo: 500
description	string	Não	Descrição opcional do artefato Comprimento máximo: 2000

Resposta (200):

Artefato atualizado

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
displayName	string	Sim	Padrão: "" Comprimento máximo: 500
description	string	Sim	Comprimento máximo: 2000
originalFileName	string	Sim	Padrão: "" Comprimento máximo: 500
mimeType	string	Sim	Padrão: "" Comprimento máximo: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Sim	Valores permitidos: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Sim	Valores permitidos: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Padrão: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Sim	Valores permitidos: Uploading, Ready, Failed, Deleted Padrão: Uploading
hasThumbnail	boolean	Sim	Padrão: false
sizeBytes	number	Sim	Padrão: 0
createdAt	string	Sim	Formato: date-time
createdBy	string	Não	Formato: uuid

Erros:

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

Excluir um artefato

Endpoint: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

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

Parâmetros:

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

Resposta (200):

Artefato excluído

{
	"deleted": true
}

Campo	Tipo	Obrigatório	Descrição
deleted	boolean	Sim

Erros:

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

Redirecionar para uma URL pré-assinada para baixar o artefato

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

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

Parâmetros:

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

Erros:

• 302 Redirecionamento para a URL de download pré-assinada
• 401 Chave de API ausente, inválida, desativada ou expirada
• 404 Recurso não encontrado

Listar artefatos anexados a um processo

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

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

Parâmetros:

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

Resposta (200):

Lista de artefatos do processo

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

Erros:

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

Obter uma URL de upload S3 pré-assinada para um novo artefato do processo

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

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

Parâmetros:

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

Corpo da solicitação:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}

Campo	Tipo	Obrigatório	Descrição
fileName	string	Sim
mimeType	string	Sim
sizeBytes	number	Sim
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	Não	Valores permitidos: modelIcon, processArtifact, doc, levelFrontPageImage Padrão: processArtifact

Resposta (200):

URL de upload pré-assinada

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}

Campo	Tipo	Obrigatório	Descrição
artifactId	string	Sim	Formato: uuid
originalUrl	string	Sim
thumbnailUrl	string	Sim

Erros:

• 400 Solicitação inválida: por exemplo, uma expressão de filtro inválida, um processo sem modelo, um tipo de upload não compatível ou um campo obrigatório ausente
• 401 Chave de API ausente, inválida, desativada ou expirada
• 403 A chave de API não tem o escopo ou o acesso à organização necessários, o ambiente está inativo ou o plano bloqueia o tipo de arquivo
• 404 Recurso não encontrado
• 409 A solicitação entra em conflito com o estado atual (por exemplo, uma restrição de licença ou um ID reutilizado)