API REST

Este documento contiene la lista de todas las API REST que se pueden utilizar con IBM Process Mining.

Nota:: Para todos los detalles técnicos, consulte los documentos relativos en formato Swagger/Open API.

Perfil de usuario

El perfil de usuario obtiene todos los detalles relacionados con el perfil de usuario de API, que es obligatorio para las solicitudes de API.

Servicios de API REST

Obtener la hora del servidor

Esta solicitud de API recupera el tiempo de servidor actual que se debe utilizar como base de tiempo para las solicitudes de API subsiguientes.

Obtener la señal de autenticación web

Esta solicitud de API genera una señal de autenticación OTP para una conexión web con IBM Process Mining.

Obtener el acceso web

Este URL habilita una sesión de navegador web de IBM Process Mining.

Obtener la lista de proyectos

Esta solicitud de API recupera la lista de procesos en los que el usuario tiene autorización para trabajar.

Obtener información de proceso

Esta solicitud de API recupera la información relacionada con el proyecto identificado por la clave de proyecto.

Cómo obtener el flujo de trabajo

Esta solicitud de API recupera el flujo de trabajo del proceso como SVG. El flujo de trabajo devuelto refleja el nivel de detalle predeterminado que se establece en los valores del proyecto. Para que esta API funcione, el componente "PhantomJs" debe estar instalado en el servidor.

Obtener el modelo de proceso

Esta solicitud de API recupera el modelo de proceso actual como BPMN o XPDL.

Obtener las actividades de proceso

Esta solicitud de API recupera todas las actividades que se ejecutan durante el proceso.

Obtener los atributos de proceso

Esta solicitud de API recupera los atributos personalizados incluidos en el análisis de proceso.

Obtener las entidades de proceso

Esta solicitud de API recupera las entidades empresariales de un proceso de varios niveles; si el proceso de destino no es de varios niveles, la respuesta devuelve un error.

Cargar un conjunto de datos

Esta solicitud de API carga un nuevo conjunto de datos en un proyecto existente.

Nota:: Tenga cuidado de que la solicitud no vuelva a generar automáticamente el registro de sucesos actual o las instantáneas enlazadas. Para incluir el nuevo conjunto de datos en el flujo de trabajo de proceso y las estadísticas, debe llamar a la API "Generar el registro de sucesos".

Generar el registro de sucesos

Esta solicitud de API ejecuta el algoritmo de minería de procesos en el proceso de destino para generar un nuevo registro de sucesos a partir de los datos cargados.

Cómo restablecer una instantánea

Esta solicitud de API ejecuta el restablecimiento de la instantánea de destino frente al propietario del proyecto. Si el proyecto de destino no es una instantánea, no se ejecuta ninguna acción.

Crear un proyecto

Esta solicitud de API crea un proyecto nuevo con el título especificado en la organización de destino.

API de Business Rules

Una nueva API REST permite a las aplicaciones de terceros activar las reglas de descubrimiento de negocio. Con esta API, el sistema externo puede obtener la lista de pasarelas y Business Rules relacionadas con ella para un proceso específico.

Importar datos de proceso de BAI

Para obtener las aplicaciones de proceso BPMN, es necesario realizar los siguientes pasos con distintas API REST:

1. Obtener la lista de aplicaciones de proceso de BAI: esta solicitud de API recupera la lista de aplicaciones de proceso de BAI.

2. Obtener la lista de versiones para la aplicación de proceso de destino de BAI: esta solicitud de API recupera la lista de versiones para la aplicación de proceso de destino de BAI.

3. Obtener la lista de procesos para la aplicación de proceso de destino desde BAI: esta solicitud de API recupera la lista de procesos para la aplicación de proceso de destino desde BAI.

4. Importar datos de proceso de BAI (Async): esta solicitud de API realiza la importación de datos desde BAI al proyecto de destino. Esta API inicia un proceso asíncrono: el llamante recibe el ackowledgment, tan pronto como la solicitud se envía a la interconexión del servidor, o un mensaje de error, si se detecta un problema en los datos de entrada. En caso de éxito, la respuesta proporciona la clave de trabajo que se puede utilizar para investigar el estado de la solicitud llamando a la API de control de trabajos.

5. Obtener el estado de un trabajo asíncrono relacionado con la importación de datos de BAI: esta solicitud de API comprueba el estado de un trabajo relacionado con la importación de datos de BAI.

Note1: En esta API REST, el usuario puede seleccionar los entornos de referencia con un parámetro opcional baiConfigKey. Este parámetro toma la información del archivo de configuración donde se inserta la lista de todos los entornos de referencia.

Note2: En Cloud Pak, no se utiliza la lista de entornos, pero se definen las variables de entorno.