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

Referencia de la API: procesos

Estos endpoints funcionan en su propio espacio de trabajo. Comience una prueba gratuita para crear uno y realizar su primera llamada a la API.

Listar 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 superior (null = nivel superior)
Formato: uuid
treeNodeType Process | TreeGroup No Proceso o TreeGroup (carpeta)
Valores permitidos: Process, TreeGroup
Valor 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
Valor predeterminado: Process
displayName string Sí Valor 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: puede volver a intentar la solicitud sin riesgo

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
Valor predeterminado: Process
displayName string Sí Valor 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 No se encontró el recurso

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 superior (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
Valor predeterminado: Process
displayName string Sí Valor 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 No se encontró el recurso
  • 500 Error inesperado del servidor: puede volver a intentar la solicitud sin riesgo

Eliminar un proceso de forma lógica

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 No se encontró el recurso

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 vencido
  • 403 La clave de API no tiene el ámbito o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite este tipo de archivo
  • 404 No se encontró el recurso
  • 500 Error inesperado del servidor: puede volver a enviar la solicitud sin riesgo

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 archivo no compatible o un campo obligatorio ausente
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

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

Listar 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 archivo no compatible o un campo obligatorio ausente
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

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 mapeará al proceso
Formato: uuid
displayName string No Nombre para mostrar del mapeo
Longitud máxima: 128
color object No Color de acento
showByDefault boolean No Mostrar este mapeo de forma predeterminada en la vista del proceso
Valor predeterminado: true
mappingRole primary | comparison No Función de los datos mapeados en el modelo
Valores permitidos: primary, comparison

Respuesta (201):

Mapeo creado

{
	"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 archivo no admitido o la falta de un campo obligatorio
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha vencido
  • 403 La clave de API no tiene el ámbito o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite este tipo de archivo
  • 404 No se encontró el recurso

Actualizar un mapeo

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

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
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):

Mapeo actualizado

{
	"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 archivo no compatible o un campo obligatorio ausente
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Eliminar un mapeo

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

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
mappingId string ruta Sí Formato: uuid

Respuesta (200):

Mapeo eliminado

{
	"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 archivo no compatible o un campo obligatorio ausente
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Estos endpoints usan 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 alcance de inquilino · alcance write · límite de solicitudes: 2 por segundo (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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Consultar el estado de generación del modelo

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

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):

Estado de generación

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

Errores:

  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

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 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, longitud, conformidad, retrabajo, puntuación de salud, variante y otras) para el modelo más reciente. No se aplica ningún filtro a las filas. El resultado está paginado: use limit (valor predeterminado: 1000; máximo: 10000) y offset, y siga consultando 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 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 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 archivo no compatible o un campo obligatorio ausente
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso
  • 503 El pipeline de datos no está listo o se produjo un error en una consulta a un sistema ascendente

Listar las versiones de un proceso

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

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 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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Crear una instantánea de versión del proceso

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

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",
	"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á el proceso 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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Obtener una versión del proceso

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

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

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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Cambiar el nombre o actualizar una versión del proceso

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

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

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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Eliminar una versión del proceso

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

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

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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Obtener un artefacto

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

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

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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Actualizar el nombre para mostrar o la descripción de un artefacto

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

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

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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Eliminar un artefacto

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

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

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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Redirigir a una URL prefirmada para descargar el artefacto

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

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

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 prefirmada de descarga
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

Listar los artefactos asociados a un proceso

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

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

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, no es válida, está deshabilitada o ha caducado
  • 404 No se encontró el recurso

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

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

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

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 prefirmada

{
	"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 admitido o un campo obligatorio ausente
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 403 La clave de API no tiene el ámbito o el acceso a la organización necesarios, el inquilino está inactivo o el plan no admite este tipo de archivo
  • 404 No se encontró el recurso
  • 409 La solicitud entra en conflicto con el estado actual (por ejemplo, por una restricción de licencias o por reutilizar un ID)

Documentación relacionada

Diseñe mejores procesos. Conecte su arquitectura. Mantenga el control.

Acceda de inmediato, sin tarjeta de crédito ni esperas. Transforme la forma de trabajar de su organización en diseños de procesos claros y conectados.

Defina la arquitectura de procesos, los responsables y los controles, y alinee las funciones y responsabilidades en todos los niveles.

Comience su prueba gratuita y establezca una base fiable para gobernar, gestionar y mejorar continuamente sus procesos.

Comience hoy su prueba gratuita