Celonis (versión preliminar)
Celonis Platform API para trabajar con elementos del modelo de conocimiento, como registros, KPI, filtros, desencadenadores y sus datos relacionados.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Soporte técnico de Celonis |
| URL | https://developer.celonis.com/ |
| Correo Electrónico | intelligence-api-feedback-sc@celonis.de |
| Metadatos del conector | |
|---|---|
| Publicador | Celonis |
| Sitio web | https://www.celonis.com |
| Directiva de privacidad | https://www.celonis.com/privacy-policy/ |
| Categorías | IA; Gestión empresarial |
Title
La API de Celonis Intelligence permite a los clientes de Celonis insertar inteligencia de proceso accionable en plataformas de terceros en las que los usuarios finales pueden beneficiarse de las conclusiones del proceso de Celonis. De esta manera, aportaría inteligencia de Celonis, como KPI de proceso o ineficacias de procesos, a los usuarios finales y beneficiaría a los usuarios operativos sin acceso actual a Celonis proporcionando información valiosa para una mejor toma de decisiones mientras ejecuta sus actividades diarias. Además de la funcionalidad de consulta de datos, Intelligence API también admite la inserción de datos en plataformas de terceros al permitirles suscribirse a desencadenadores empresariales.
Publicador: nombre del publicador
Prerrequisitos
- Un equipo en Celonis Platform.
- Un modelo de conocimiento disponible en el equipo de un cliente.
- Suscripción a Celonis basada en procesos (póngase en contacto con el equipo de su cuenta para comprobar).
Operaciones admitidas
Los métodos de API actuales permiten a los consumidores interactuar con los modelos de conocimiento definidos en Celonis Platform proporcionando las siguientes funcionalidades:
Métodos de detección de modelos de conocimiento
Obtener una lista de modelos de conocimiento (KM)
Obtener una lista de registros de KM
Obtener detalles del esquema de registros de KM
Obtener una lista de filtros de KM
Métodos de recuperación de datos del modelo de conocimiento
Obtener una lista de datos de registro de KM
Métodos de administración del ciclo de vida de la suscripción
Obtener una lista de suscripciones
Obtener una lista de desencadenadores de KM
Crear una suscripción a un desencadenador de KM
Actualizar una suscripción
Pausar una suscripción
Reanudar una suscripción
Finalizar una suscripción
Obtención de credenciales
Autenticación
Cada solicitud a la API debe autenticarse con una clave de API de Celonis. Hay dos maneras de hacerlo:
Uso de una clave de API de usuario
Puede averiguar cómo crear una clave de API de usuario siguiendo nuestra guía de claves de API de usuario. La API de Celonis usa la autenticación de token de portador para comprobar el acceso de los consumidores. Las credenciales deben enviarse en un encabezado authorization en la solicitud HTTP. Las credenciales enviadas en la dirección URL o el cuerpo de la solicitud se omitirán. Para autenticarse mediante la autenticación de token de portador:
- Cree el token en Celonis:
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Incluya la cadena en el encabezado de autorización HTTP con el formato siguiente:
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Uso de una clave de API de aplicación
Puede averiguar cómo crear una appKey siguiendo nuestra guía de claves de API de aplicación. Para autenticarse mediante la autenticación appKey:
- Cree appKey en Celonis:
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Incluya la cadena en el encabezado de autorización HTTP con el formato siguiente:
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
Debe establecer los permisos adecuados y asegurarse de que la clave de API de usuario o la clave de API de aplicación aprovechada para fines de autorización tiene acceso al paquete celonis Studio que contiene los modelos de conocimiento a los que desea acceder a través de las API de inteligencia. Puede conceder permisos de acceso siguiendo estos pasos:
- Vaya al paquete de Studio.
- Haga clic en los tres puntos y seleccione
Permissionsen el menú emergente. - Busque el usuario (en caso de que use un token de portador ) o AppKey (en caso de que use una appKey ) y conceda al menos
USE PACKAGEderechos.
Introducción
La dirección URL base de la API de Celonis es https://<team>.<cluster>.celonis.cloud/intelligence/api Buscar el equipo y el clúster, compruebe la dirección URL que usa para acceder a la Plataforma Celonis y recuperar el equipo y el clúster de ella.
La API de Celonis Intelligence es una API JSON y sus puntos de conexión siempre devolverán una respuesta JSON, independientemente del éxito de la solicitud.
Los métodos de API actuales permiten a los consumidores interactuar con los modelos de conocimiento definidos en Celonis Platform proporcionando las siguientes funcionalidades:
- Lista de modelos de conocimiento disponibles y sus detalles
- Lista de registros y sus detalles
- Lista de filtros
- Datos de un registro específico. Detalles sobre las características de celonis Intelligence API en el portal para desarrolladores de Celonis.
Problemas conocidos y limitaciones
Limitación de frecuencia
La API de inteligencia no se creó para exportar datos RAW de forma masiva, sino para que los resultados calculados y la información de la minería de datos de procesos estén disponibles para las plataformas y aplicaciones de terceros. Por eso la API de Celonis aplica la limitación de velocidad. Esto significa que solo se permite un número determinado de solicitudes al día y se puede recuperar un número determinado de registros en cada llamada. Celonis se reserva el derecho de ajustar los límites de tarifas en cualquier momento para garantizar un servicio de alta calidad para todos los clientes.
En caso de que un cliente supere repetidamente los límites de velocidad o participe en el comportamiento que se considera sospechoso, Celonis se reserva el derecho de limitar de forma temporal o permanente o suspender el acceso a la API para ese cliente.
Cuando un cliente supera el número de solicitudes al día, la API de Celonis devolverá una respuesta 429 (demasiadas solicitudes), incluido un encabezado HTTP () que indica el tiempo (x-ratelimit-reseten segundos) que el cliente debe esperar antes de que se pueda procesar una nueva solicitud.
Los siguientes encabezados HTTP también se devuelven como parte de cada llamada:
-
x-ratelimit-limit: representa el número máximo de solicitudes que el cliente puede realizar en el período de tiempo actual. -
x-ratelimit-remaining: número de solicitudes restantes en el período de tiempo actual. Actualmente, la API tiene los siguientes límites predeterminados:
Tabla 1. Límites de velocidad de solicitudes predeterminados
|
Límite | Valores predeterminados | |--|--| | Número máximo de solicitudes/día | 6000 requests/day | | Número máximo de solicitudes/segundo | 20 requests/second | | Número máximo de campos permitidos por solicitud en el modelo de conocimiento | 200 fields/request | | Número máximo de registros por solicitud devuelta al llamar al /data punto de conexión | 50 registros/solicitud | | Número máximo total de registros que se pueden recuperar a través del /data punto de conexión | Primeros 5.000 registros por tabla filtrada o ordenada | La suscripción al desencadenador también aplica la limitación de velocidad. Esto significa que para un equipo, solo se puede crear un número determinado de suscripciones. Además, independientemente del número de suscripciones que se creen, hay un número máximo de eventos que se pueden emitir desde la API a los consumidores de terceros.
Si un cliente alcanza el número máximo de suscripciones, deberá eliminar una suscripción existente para crear una nueva.
Si un cliente alcanza el número máximo de eventos emitidos desde la API, se descartarán el resto de datos generados por Celonis Platform.
Si el cliente se acerca a su cuota diaria, se le informará a través de correos electrónicos a su cuenta de administrador. El primer correo electrónico se enviará cuando se superen 80% de la cuota, lo que permite que la cuenta de administrador sepa que supera ese porcentaje. El segundo correo electrónico se enviará en cuanto supere los 100% de la cuota.
Actualmente, la API tiene los siguientes límites predeterminados:
Tabla 2. Límites de velocidad de eventos predeterminados
|
Límite | Valores predeterminados | |--|--| | Número máximo de suscripciones o equipo | 10 | | Número máximo de eventos/día | 100,000 | Consulte al equipo de su cuenta para comprobar los límites de su equipo.
Preguntas más frecuentes
Consulte la sección Preguntas más frecuentes del Portal para desarrolladores de Celonis.
Instrucciones de implementación
Obligatorio. Agregue instrucciones sobre cómo implementar este conector como conector personalizado.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Equipo | cuerda / cadena | Especifique el equipo de Celonis. | Cierto |
| Clúster | cuerda / cadena | Especifique el clúster de Celonis. | Cierto |
| Authorization | securestring | Autorización para esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualiza una suscripción |
Actualiza una suscripción |
| Cancelar la suscripción de un desencadenador quitando todos los datos de la suscripción |
Cancelar la suscripción de un desencadenador quitando todos los datos de la suscripción |
| Crea una suscripción para el desencadenador |
Crea una suscripción para el desencadenador |
| Obtención de los detalles del esquema de registro de KM de nivel superior |
Detalles del esquema de registro de nivel superior |
| Obtención de los detalles del KM de nivel superior |
Modelo de conocimiento definido en un equipo de EMS |
| Obtener una lista de datos de registro de KM |
Datos de un registro en el modelo de conocimiento |
| Obtener una lista de desencadenadores de KM |
Lista de desencadenadores para el modelo de conocimiento |
| Obtener una lista de filtros de KM |
Lista de filtros para el modelo de conocimiento |
| Obtener una lista de KMs |
Lista de modelos de conocimiento definidos en un equipo de EMS |
| Obtener una lista de suscripciones |
Lista de todas las suscripciones creadas |
| Obtener una lista del esquema de registros de KM |
Lista de esquemas de registros |
| Pausa la suscripción para dejar de recibir eventos |
Pausa la suscripción para dejar de recibir eventos |
| Reanuda la suscripción en pausa para empezar a recibir eventos de nuevo. |
Reanuda la suscripción en pausa para empezar a recibir eventos de nuevo. |
| Reanuda la suscripción para empezar a recibir nuevos eventos, descartar eventos del historial |
Reanuda la suscripción en pausa para empezar a recibir nuevos eventos de nuevo, descartando eventos del historial. |
| Recupera la página siguiente de eventos no se reenviaron debido a un error de suscripción. |
Recupera la página siguiente de eventos si no se reenviaron debido a un error de suscripción. |
Actualiza una suscripción
Actualiza una suscripción
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de suscripción que se actualizará por completo. |
|
headers
|
headers | object |
Los encabezados de devolución de llamada pueden contener token de autenticación, tipo de contenido, etc. |
|
|
protocol
|
protocol | True | string |
Solo el valor posible realmente es HTTPS, lo que significa que el URI de devolución de llamada debe ser un https válido. |
|
Uri
|
uri | True | string |
URI para realizar la devolución de llamada desde Intelligence API una vez desencadenado el desencadenador |
|
configuraciones
|
configurations | array of string |
Configuración de la suscripción |
|
|
nombre
|
name | True | string |
Nombre de la suscripción |
Cancelar la suscripción de un desencadenador quitando todos los datos de la suscripción
Cancelar la suscripción de un desencadenador quitando todos los datos de la suscripción
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscription_id | True | string |
Se eliminará el identificador de suscripción. |
Crea una suscripción para el desencadenador
Crea una suscripción para el desencadenador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de km
|
km_id | True | string |
Identificador del modelo de conocimiento |
|
Id. de desencadenador
|
trigger_id | True | string |
Identificador del desencadenador |
|
headers
|
headers | object |
Los encabezados de devolución de llamada pueden contener token de autenticación, tipo de contenido, etc. |
|
|
protocol
|
protocol | True | string |
Solo el valor posible realmente es HTTPS, lo que significa que el URI de devolución de llamada debe ser un https válido. |
|
Uri
|
uri | True | string |
URI para realizar la devolución de llamada desde Intelligence API una vez desencadenado el desencadenador |
|
configuraciones
|
configurations | array of string |
Configuración de la suscripción |
|
|
nombre
|
name | True | string |
Nombre de la suscripción |
Devoluciones
- response
- string
Obtención de los detalles del esquema de registro de KM de nivel superior
Detalles del esquema de registro de nivel superior
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del modelo de conocimiento
|
km_id | True | string |
Id. del modelo de conocimiento |
|
Identificador de registro
|
record_id | True | string |
Identificador de registro |
Devoluciones
Registro representa un concepto dentro de un modelo de conocimiento
- Tipo de registro
- recordDTO
Obtención de los detalles del KM de nivel superior
Modelo de conocimiento definido en un equipo de EMS
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del modelo de conocimiento
|
km_id | True | string |
Id. del modelo de conocimiento |
Devoluciones
Estructura de los datos del modelo de conocimiento
- Modelo de conocimiento
- knowledgeModelDetailedDTO
Obtener una lista de datos de registro de KM
Datos de un registro en el modelo de conocimiento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del modelo de conocimiento
|
km_id | True | string |
Id. del modelo de conocimiento |
|
Identificador de registro
|
record_id | True | string |
Identificador de registro |
|
Filtros
|
filters | array |
Identificador de filtro predefinido |
|
|
Identificadores de campo
|
fields | True | array |
Identificador de filtro predefinido |
|
Página
|
page | integer |
Número de página del resultado, empezando por 0 (primera página) |
|
|
Tamaño de página
|
pageSize | integer |
Número de elementos devueltos en una página. |
|
|
Ordenación
|
sort | array |
Define la estrategia para continuar con la ordenación. Debe ser una lista separada por comas de campos y debe empezar por "+" para aplicar el orden de ASC o "-" para aplicar el orden DESC. Los campos sin prefijo se ordenarán como ASC. Los campos no existentes en el encabezado producirán un error |
|
|
Expresión de filtro
|
filterExpr | array |
Expresiones de filtro dinámico |
Devoluciones
- Página de resultados de datos de registro
- recordResultPageDTO
Obtener una lista de desencadenadores de KM
Lista de desencadenadores para el modelo de conocimiento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página del resultado, empezando por 0 (primera página) |
|
|
Tamaño de página
|
pageSize | integer |
Número de elementos devueltos en una página. |
|
|
Ordenar
|
sort | string |
Define la estrategia para continuar con la ordenación sin distinción entre mayúsculas y minúsculas. Debe ser solo un campo y debe comenzar con "+" para aplicar el orden de ASC o "-" para aplicar el orden DESC. El prefijo no prefijo se ordenará como ASC. El campo no existente en el encabezado producirá un error. |
|
|
Id. de km
|
km_id | True | string |
Identificador del modelo de conocimiento |
Devoluciones
- Página de resultados del esquema de desencadenador
- triggerResultPage
Obtener una lista de filtros de KM
Lista de filtros para el modelo de conocimiento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página del resultado, empezando por 0 (primera página) |
|
|
Tamaño de página
|
pageSize | integer |
Número de elementos devueltos en una página. |
|
|
Ordenación
|
sort | string |
Define la estrategia para continuar con la ordenación sin distinción entre mayúsculas y minúsculas. Debe ser solo un campo y debe comenzar con "+" para aplicar el orden de ASC o "-" para aplicar el orden DESC. El prefijo no prefijo se ordenará como ASC. El campo no existente en el encabezado producirá un error. |
|
|
Id. del modelo de conocimiento
|
km_id | True | string |
Id. del modelo de conocimiento |
Devoluciones
- Página de resultados del esquema de filtro
- filterResultPage
Obtener una lista de KMs
Lista de modelos de conocimiento definidos en un equipo de EMS
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página del resultado, empezando por 0 (primera página) |
|
|
Tamaño de página
|
pageSize | integer |
Número de elementos devueltos en una página. |
|
|
Ordenación
|
sort | string |
Define la estrategia para continuar con la ordenación sin distinción entre mayúsculas y minúsculas. Debe ser solo un campo y debe comenzar con "+" para aplicar el orden de ASC o "-" para aplicar el orden DESC. El prefijo no prefijo se ordenará como ASC. El campo no existente en el encabezado producirá un error. |
Devoluciones
- Página de resultados de KnowledgeModel
- knowledgeModelResultPage
Obtener una lista de suscripciones
Lista de todas las suscripciones creadas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página del resultado, empezando por 0 (primera página) |
|
|
Tamaño de página
|
pageSize | integer |
Número de elementos devueltos en una página. |
|
|
Ordenar
|
sort | string |
Define la estrategia para continuar con la ordenación sin distinción entre mayúsculas y minúsculas. Debe ser solo un campo y debe comenzar con "+" para aplicar el orden de ASC o "-" para aplicar el orden DESC. El prefijo no prefijo se ordenará como ASC. El campo no existente en el encabezado producirá un error. |
Devoluciones
- Página de resultados del esquema de suscripción
- subscriptionResultPage
Obtener una lista del esquema de registros de KM
Lista de esquemas de registros
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página del resultado, empezando por 0 (primera página) |
|
|
Tamaño de página
|
pageSize | integer |
Número de elementos devueltos en una página. |
|
|
Ordenación
|
sort | string |
Define la estrategia para continuar con la ordenación sin distinción entre mayúsculas y minúsculas. Debe ser solo un campo y debe comenzar con "+" para aplicar el orden de ASC o "-" para aplicar el orden DESC. El prefijo no prefijo se ordenará como ASC. El campo no existente en el encabezado producirá un error. |
|
|
Id. del modelo de conocimiento
|
km_id | True | string |
Id. del modelo de conocimiento |
Devoluciones
- Página de resultados del esquema de registro
- recordSchemaResultPage
Pausa la suscripción para dejar de recibir eventos
Pausa la suscripción para dejar de recibir eventos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscription_id | True | string |
El identificador de suscripción se pausará. |
Reanuda la suscripción en pausa para empezar a recibir eventos de nuevo.
Reanuda la suscripción en pausa para empezar a recibir eventos de nuevo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscription_id | True | string |
El identificador de suscripción se reanudará y empezará a recibir el evento de nuevo. |
Reanuda la suscripción para empezar a recibir nuevos eventos, descartar eventos del historial
Reanuda la suscripción en pausa para empezar a recibir nuevos eventos de nuevo, descartando eventos del historial.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscription_id | True | string |
El identificador de suscripción se reanudará sin recibir eventos pasados. |
Recupera la página siguiente de eventos no se reenviaron debido a un error de suscripción.
Recupera la página siguiente de eventos si no se reenviaron debido a un error de suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de suscripción que recuperará el evento con errores enviado, en un máximo de 50 elementos. |
Devoluciones
- Página de resultados de señal
- SignalResultPage
Definiciones
SignalResultPage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contenido
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Tamaño de página, definido por el sistema |
filterDTO
Filtro para aplicar en un KM
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
descripción
|
description | string |
Descripción del filtro comprensible para humanos |
|
id
|
id | string |
Identificador único del filtro |
|
nombre
|
name | string |
Nombre para mostrar de filtro comprensible para humanos |
filterResultPage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamaño de página, definido por el parámetro pageSize |
|
sort
|
sort | string |
Campo usado para aplicar la ordenación a los datos solicitados, + o ningún símbolo significa ASC, : significa DESC |
|
total
|
total | integer |
Total de elementos devueltos en la página |
|
contenido
|
content | array of filterDTO |
knowledgeModelDetailedDTO
Estructura de los datos del modelo de conocimiento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único del modelo de conocimiento |
|
nombre
|
name | string |
Texto comprensible para personas |
|
extendedKMId
|
extendedKMId | string |
Modelo de conocimiento usado como referencia, base de KM. |
knowledgeModelResultPage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamaño de página, definido por el parámetro pageSize |
|
sort
|
sort | string |
Campo usado para aplicar la ordenación a los datos solicitados, + o ningún símbolo significa ASC, : significa DESC |
|
total
|
total | integer |
Total de elementos devueltos en la página |
|
contenido
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
Estructura de los datos del modelo de conocimiento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único del modelo de conocimiento |
|
nombre
|
name | string |
Texto comprensible para personas |
|
publicado
|
published | string |
Fecha de publicación más reciente |
recordDTO
Registro representa un concepto dentro de un modelo de conocimiento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
descripción
|
description | string |
Descripción del registro |
|
id
|
id | string |
Identificador único del registro |
|
nombre
|
name | string |
Registrar el nombre para mostrar, un nombre comprensible para humanos |
|
fields
|
fields | array of recordFieldDTO |
recordFieldDTO
Campos de un registro
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
format
|
format | string |
Formato que se va a aplicar |
|
id
|
id | string |
Importe pendiente de pago |
|
nombre
|
name | string |
nombre comprensible para humanos |
|
type
|
type | string | |
|
unidad
|
unit | string |
Unidad agregada al valor de campo |
recordIdDTO
Identificador y nombre del tipo de registro
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
descripción
|
description | string |
Descripción del registro |
|
id
|
id | string |
Identificador único del registro |
|
nombre
|
name | string |
Registrar el nombre para mostrar, un nombre comprensible para humanos |
recordItemDTO
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of |
Lista de elementos de registro, compuestos con nombre y valor |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
agregación
|
aggregation | boolean |
Indica si un campo es una información de agregación o calculada (KPI). |
|
filterable
|
filterable | boolean |
Indique si el campo se puede filtrar. |
|
format
|
format | string |
Expresión de formato |
|
id
|
id | string |
Identidad de campo que se va a usar en el parámetro de lista de campos y filterExpression |
|
nombre
|
name | string |
Texto comprensible para personas |
|
sortable
|
sortable | boolean |
Indique si el campo se podría ordenar. |
|
type
|
type | string |
Tipos de datos posibles. |
|
unidad
|
unit | string |
Un signo complementario para la vista de valores de formato |
recordResultPageDTO
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamaño de página, definido por el parámetro pageSize |
|
sort
|
sort | array of string | |
|
total
|
total | integer |
Total de elementos devueltos en la página |
|
Elemento de registro
|
content | recordItemDTO |
recordSchemaResultPage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamaño de página, definido por el parámetro pageSize |
|
sort
|
sort | string |
Campo usado para aplicar la ordenación a los datos solicitados, + o ningún símbolo significa ASC, : significa DESC |
|
total
|
total | integer |
Total de elementos devueltos en la página |
|
contenido
|
content | array of recordIdDTO |
signalDTO
Señal almacenada en la suscripción
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
signal
|
signal | string |
Json sin formato de una señal |
|
ID de suscripción
|
subscriptionId | string |
Identificador único del suscriptor como SUID |
|
triggerId
|
triggerId | string |
Identificador único del desencadenador como SUID |
|
fechaDeCreación
|
creationDate | date-time |
Fecha de creación de la señal |
subscriptionDTO
Esquema de suscripción
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
configuraciones
|
configurations | array of string |
Configuración de la suscripción |
|
id
|
id | string |
Identificador único del suscriptor como SUID |
|
knowledgeModelId
|
knowledgeModelId | string |
Identificador único del modelo de conocimiento |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Fecha del último evento correcto |
|
nombre
|
name | string |
Nombre de suscripción comprensible para humanos |
|
estado
|
status | string | |
|
triggerId
|
triggerId | string |
Identificador único del desencadenador como SUID |
subscriptionResultPage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamaño de página, definido por el parámetro pageSize |
|
sort
|
sort | string |
Campo usado para aplicar la ordenación a los datos solicitados, + o ningún símbolo significa ASC, : significa DESC |
|
total
|
total | integer |
Total de elementos devueltos en la página |
|
contenido
|
content | array of subscriptionDTO |
triggerDTO
Desencadenador definido en KM
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único del desencadenador como SUID |
|
nombre
|
name | string |
Nombre del desencadenador comprensible para humanos |
|
registro
|
record | string |
Identificador único del registro como SUID |
triggerResultPage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamaño de página, definido por el parámetro pageSize |
|
sort
|
sort | string |
Campo usado para aplicar la ordenación a los datos solicitados, + o ningún símbolo significa ASC, : significa DESC |
|
total
|
total | integer |
Total de elementos devueltos en la página |
|
contenido
|
content | array of triggerDTO |
cuerda / cadena
Este es el tipo de datos básico "string".