En esta página
> recursos > documentacion > api > Referencia de API: Procesos

Referencia de API: Procesos

Enumerar procesos

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

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
limit integer consulta No Número máximo de elementos que se devolverán
offset integer consulta No Número de elementos que se omitirán

Respuesta (200):

Lista de procesos

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

Errores:

  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado

Crear un proceso (con un modelo vacío)

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

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}
Campo Tipo Obligatorio Descripción
displayName string Sí Nombre del proceso que se muestra en el árbol de procesos
Longitud máxima: 128
treeParentId string No ID de la carpeta principal (null = nivel superior)
Formato: uuid
treeNodeType Process | TreeGroup No Proceso o TreeGroup (carpeta)
Valores permitidos: Process, TreeGroup
Predeterminado: Process

Respuesta (201):

Proceso creado

{
	"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 Obligatorio Descripción
id string Sí Formato: uuid
treeParentId string Sí Formato: uuid
treeNodeType Process | TreeGroup Sí Valores permitidos: Process, TreeGroup
Predeterminado: Process
displayName string Sí Predeterminado: New Process
Longitud máxima: 128
createdAt string Sí Formato: date-time
updatedAt string Sí Formato: date-time
designerModelId string Sí Formato: uuid

Errores:

  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 500 Error inesperado del servidor: la solicitud se puede volver a intentar de forma segura

Obtener un proceso

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

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Respuesta (200):

Proceso

{
	"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 Obligatorio Descripción
id string Sí Formato: uuid
treeParentId string Sí Formato: uuid
treeNodeType Process | TreeGroup Sí Valores permitidos: Process, TreeGroup
Predeterminado: Process
displayName string Sí Predeterminado: New Process
Longitud máxima: 128
createdAt string Sí Formato: date-time
updatedAt string Sí Formato: date-time
designerModelId string Sí Formato: uuid

Errores:

  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Actualizar un proceso

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

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}
Campo Tipo Obligatorio Descripción
displayName string No Nombre del proceso que se muestra en el árbol de procesos
Longitud máxima: 128
treeParentId string No ID de la carpeta principal (null = nivel superior)
Formato: uuid

Respuesta (200):

Proceso actualizado

{
	"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 Obligatorio Descripción
id string Sí Formato: uuid
treeParentId string Sí Formato: uuid
treeNodeType Process | TreeGroup Sí Valores permitidos: Process, TreeGroup
Predeterminado: Process
displayName string Sí Predeterminado: New Process
Longitud máxima: 128
createdAt string Sí Formato: date-time
updatedAt string Sí Formato: date-time
designerModelId string Sí Formato: uuid

Errores:

  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado
  • 500 Error inesperado del servidor: la solicitud se puede volver a intentar de forma segura

Eliminar de forma lógica un proceso

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

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Respuesta (200):

Proceso eliminado

{
	"success": true,
	"message": "string"
}
Campo Tipo Obligatorio Descripción
success boolean Sí
message string Sí

Errores:

  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Exportar el modelo de proceso como XML BPMN 2.0

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

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Respuesta (200):

XML BPMN

{
	"bpmnXml": "string"
}
Campo Tipo Obligatorio Descripción
bpmnXml string Sí XML BPMN 2.0

Errores:

  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado
  • 500 Error inesperado del servidor: la solicitud se puede volver a intentar de forma segura

Importar un modelo BPMN 2.0 para el proceso (reemplaza el modelo actual)

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

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"bpmnXml": "string"
}
Campo Tipo Obligatorio Descripción
bpmnXml string Sí XML BPMN 2.0

Respuesta (200):

BPMN cargado

{
	"message": "string"
}
Campo Tipo Obligatorio Descripción
message string Sí

Errores:

  • 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de carga no compatible o la falta de un campo obligatorio
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Los mapeos de datos conectan tablas de datos con procesos, lo que permite visualizar y analizar los datos del registro de eventos en un modelo de proceso.

Enumerar los mapeos de datos de un proceso

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

Autenticación: Clave de API con alcance de inquilino · alcance read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
limit integer consulta No Número máximo de elementos que se devolverán
offset integer consulta No Número de elementos que se omitirán

Respuesta (200):

Lista de mapeos

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

Errores:

  • 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de carga no compatible o la falta de un campo obligatorio
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Mapear una tabla de datos al proceso (inicia el procesamiento del registro de eventos)

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

Autenticación: Clave de API con alcance de inquilino · alcance write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}
Campo Tipo Obligatorio Descripción
dataTableId string Sí Tabla de datos que se asignará al proceso
Formato: uuid
displayName string No Nombre visible de la asignación
Longitud máxima: 128
color object No Color de acento
showByDefault boolean No Mostrar esta asignación de forma predeterminada en la vista del proceso
Valor predeterminado: true
mappingRole primary | comparison No Función de los datos asignados en el modelo
Valores permitidos: primary, comparison

Respuesta (201):

Asignación creada

{
	"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 Obligatorio Descripción
id string Sí Formato: uuid
modelId string Sí Formato: uuid
dataTableId string Sí Formato: uuid
displayName string Sí Longitud máxima: 128
color object Sí
showByDefault boolean Sí Valor predeterminado: true
mappingRole primary | comparison Sí Valores permitidos: primary, comparison
Valor predeterminado: comparison
sortOrder integer Sí Valor predeterminado: 0
Mínimo: -9007199254740991
Máximo: 9007199254740991

Errores:

  • 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de carga no compatible o la ausencia de un campo obligatorio
  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Actualizar una asignación

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
mappingId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
Campo Tipo Obligatorio Descripción
displayName string No Longitud máxima: 128
color object No
showByDefault boolean No
mappingRole primary | comparison No Valores permitidos: primary, comparison
sortOrder integer No Mínimo: -9007199254740991
Máximo: 9007199254740991

Respuesta (200):

Asignación actualizada

{
	"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 Obligatorio Descripción
id string Sí Formato: uuid
modelId string Sí Formato: uuid
dataTableId string Sí Formato: uuid
displayName string Sí Longitud máxima: 128
color object Sí
showByDefault boolean Sí Valor predeterminado: true
mappingRole primary | comparison Sí Valores permitidos: primary, comparison
Valor predeterminado: comparison
sortOrder integer Sí Valor predeterminado: 0
Mínimo: -9007199254740991
Máximo: 9007199254740991

Errores:

  • 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de carga no compatible o la ausencia de un campo obligatorio
  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Eliminar una asignación

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
mappingId string ruta Sí Formato: uuid

Respuesta (200):

Asignación eliminada

{
	"success": true,
	"message": "string"
}
Campo Tipo Obligatorio Descripción
success boolean Sí
message string Sí

Errores:

  • 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de carga no compatible o la ausencia de un campo obligatorio
  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Estos endpoints utilizan IA para generar automáticamente modelos de procesos BPMN a partir de descripciones en lenguaje natural.

Generar un modelo de proceso a partir de una instrucción en lenguaje natural (asíncrono; consulte el endpoint de estado)

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write · límite de frecuencia: 2 solicitudes/s (ráfaga de 4)

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"prompt": "string"
}
Campo Tipo Obligatorio Descripción
prompt string Sí

Respuesta (200):

Generación iniciada / resultado

{
	"message": "string"
}
Campo Tipo Obligatorio Descripción
message string Sí

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Consultar el estado de generación del modelo

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Respuesta (200):

Estado de generación

{
	"message": "string"
}
Campo Tipo Obligatorio Descripción
message string Sí

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Métricas por caso del modelo más reciente del proceso: una fila por caso con la secuencia calculada y las métricas de salud.

Obtener las métricas por caso de un proceso (modelo más reciente, paginado)

Devuelve una fila por caso con las métricas calculadas del proceso (duración y longitud del caso, conformidad, retrabajo, puntuación de salud, variante y más) para el modelo más reciente del proceso. No se aplica ningún filtro de filas. El resultado está paginado: utilice limit (valor predeterminado: 1000; máximo: 10000) y offset, y continúe paginando mientras hasMore sea true. Mientras se calculan las métricas, la respuesta tiene el estado preprocessing.

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

Autenticación: Clave de API con ámbito de inquilino · ámbito read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
limit integer consulta No Número máximo de filas de casos que se devolverán (valor predeterminado: 1000; máximo: 10000)
offset integer consulta No Número de filas de casos que se omitirán (valor predeterminado: 0)

Respuesta (200):

Métricas de 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": [
		{}
	]
}

Errores:

  • 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de carga no compatible o la ausencia de un campo obligatorio
  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado
  • 503 La canalización de datos no está lista o se produjo un error en una consulta ascendente

Enumerar las versiones del proceso

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

Autenticación: Clave de API con ámbito de inquilino · ámbito read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
limit integer consulta No Número máximo de elementos que se devolverán
offset integer consulta No Número de elementos que se omitirán

Respuesta (200):

Lista de versiones

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

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Crear una instantánea de versión del proceso

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}
Campo Tipo Obligatorio Descripción
displayName string No Etiqueta de la versión
Valor predeterminado: ""
Longitud máxima: 128
description string No Descripción opcional de la versión
versionType manual | auto No manual = creada por el usuario, auto = creada por el sistema
Valores permitidos: manual, auto
restoreFromVersionId string No Versión desde la que se restaurará al crear esta instantánea
Formato: uuid

Respuesta (201):

Versión creada

{
	"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 Obligatorio Descripción
version object Sí
restoredFrom object Sí

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Obtener una versión del proceso

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

Autenticación: Clave de API con ámbito de inquilino · ámbito read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
versionId string ruta Sí Formato: uuid

Respuesta (200):

Versión

{
	"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 Obligatorio Descripción
version object Sí

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Cambiar el nombre o actualizar una versión del proceso

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
versionId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"displayName": "string",
	"description": "string"
}
Campo Tipo Obligatorio Descripción
displayName string No Etiqueta de la versión
Longitud máxima: 128
description string No Descripción opcional de la versión

Respuesta (200):

Versión actualizada

{
	"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 Obligatorio Descripción
version object Sí

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Eliminar una versión del proceso

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
versionId string ruta Sí Formato: uuid

Respuesta (200):

Versión eliminada

{
	"deleted": true
}
Campo Tipo Obligatorio Descripción
deleted boolean Sí

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Obtener un artefacto

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

Autenticación: Clave de API con ámbito de inquilino · ámbito read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
artifactId string ruta Sí Formato: uuid

Respuesta (200):

Artefacto

{
	"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 Obligatorio Descripción
id string Sí Formato: uuid
displayName string Sí Valor predeterminado: ""
Longitud máxima: 500
description string Sí Longitud máxima: 2000
originalFileName string Sí Valor predeterminado: ""
Longitud máxima: 500
mimeType string Sí Valor predeterminado: ""
Longitud máxima: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Sí Valores permitidos: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Sí Valores permitidos: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Valor predeterminado: modelIcon
uploadState Uploading | Ready | Failed | Deleted Sí Valores permitidos: Uploading, Ready, Failed, Deleted
Valor predeterminado: Uploading
hasThumbnail boolean Sí Valor predeterminado: false
sizeBytes number Sí Valor predeterminado: 0
createdAt string Sí Formato: date-time
createdBy string No Formato: uuid

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Actualizar el nombre visible o la descripción de un artefacto

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
artifactId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"displayName": "string",
	"description": "string"
}
Campo Tipo Obligatorio Descripción
displayName string No Nombre del artefacto
Longitud máxima: 500
description string No Descripción opcional del artefacto
Longitud máxima: 2000

Respuesta (200):

Artefacto actualizado

{
	"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 Obligatorio Descripción
id string Sí Formato: uuid
displayName string Sí Valor predeterminado: ""
Longitud máxima: 500
description string Sí Longitud máxima: 2000
originalFileName string Sí Valor predeterminado: ""
Longitud máxima: 500
mimeType string Sí Valor predeterminado: ""
Longitud máxima: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video Sí Valores permitidos: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage Sí Valores permitidos: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
Valor predeterminado: modelIcon
uploadState Uploading | Ready | Failed | Deleted Sí Valores permitidos: Uploading, Ready, Failed, Deleted
Valor predeterminado: Uploading
hasThumbnail boolean Sí Valor predeterminado: false
sizeBytes number Sí Valor predeterminado: 0
createdAt string Sí Formato: date-time
createdBy string No Formato: uuid

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Eliminar un artefacto

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
artifactId string ruta Sí Formato: uuid

Respuesta (200):

Artefacto eliminado

{
	"deleted": true
}
Campo Tipo Obligatorio Descripción
deleted boolean Sí

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Redirigir a una URL firmada previamente para descargar el artefacto

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

Autenticación: Clave de API con ámbito de inquilino · ámbito read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
artifactId string ruta Sí Formato: uuid

Errores:

  • 302 Redirección a la URL de descarga firmada previamente
  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Enumerar los artefactos adjuntos a un proceso

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

Autenticación: Clave de API con ámbito de inquilino · ámbito read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid
limit integer consulta No Número máximo de elementos que se devolverán
offset integer consulta No Número de elementos que se omitirán

Respuesta (200):

Lista de artefactos del proceso

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

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 404 Recurso no encontrado

Obtener una URL de carga S3 firmada previamente para un nuevo artefacto del proceso

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

Autenticación: Clave de API con ámbito de inquilino · ámbito write

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid
processId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}
Campo Tipo Obligatorio Descripción
fileName string Sí
mimeType string Sí
sizeBytes number Sí
artifactType modelIcon | processArtifact | doc | levelFrontPageImage No Valores permitidos: modelIcon, processArtifact, doc, levelFrontPageImage
Valor predeterminado: processArtifact

Respuesta (200):

URL de carga firmada previamente

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}
Campo Tipo Obligatorio Descripción
artifactId string Sí Formato: uuid
originalUrl string Sí
thumbnailUrl string Sí

Errores:

  • 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de carga no compatible o la ausencia de un campo obligatorio
  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 403 La clave de API no tiene el ámbito requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado
  • 409 La solicitud entra en conflicto con el estado actual, por ejemplo, por una restricción de licencias o por reutilizar un identificador

Documentación relacionada