Agilite (versión preliminar)
Agilit-e le permite centralizar la lógica de negocios y los procesos y exponerlos como microservicios a aplicaciones nuevas o existentes. Con el conector Agilit-e, obtiene acceso a muchos servicios, como Administración de procesos empresariales (BPM), Roles, palabras clave, plantillas y mucho más.
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 | Equipo de soporte técnico de Agilit-e |
| URL | https://agilite.io |
| Correo Electrónico | support@agilite.io |
| Metadatos del conector | |
|---|---|
| Publicador | Agilit-e |
| Sitio web | https://agilite.io |
| Directiva de privacidad | https://agilite.io/privacy-policy/ |
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 | Compartible |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Se trata de una conexión que se puede compartir. Si la aplicación de energía se comparte con otro usuario, también se comparte la conexión. Para más información, consulte introducción a los conectores para aplicaciones de lienzo: Power Apps | Microsoft Docs
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Especifique la dirección URL del servidor de API Agilit-e. (Use 'https://api.agilite.io' para Agilit-e Cloud) | cuerda / cadena | Especifique la dirección URL del servidor de API Agilit-e. (Use 'https://api.agilite.io' para Agilit-e Cloud) | Cierto |
| Clave de API (generada en 'https://portal.agilite.io' en Administración) | securestring | Clave de API (generada en 'https://portal.agilite.io' en Administración) | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Asignar rol (roles) |
Asigne el rol especificado por el usuario que sea aplicable a un registro específico. Un ejemplo de esto sería un revisor de documentos o un aprobador de permisos |
| Ejecutar (BPM) |
Envía una opción en su paso de flujo de trabajo actual. En función de las reglas de negocio, el registro se avanzará al siguiente paso del proceso y devolverá información sobre el siguiente paso a la API que realiza la llamada. |
| Ejecutar (plantillas) |
Procesa y devuelve una plantilla de Agilit-e basada en la "clave-perfil" proporcionada. |
| Generar número (numeración) |
Genera un número único basado en la "clave de perfil" proporcionada. |
| Obtener claves de perfil por grupo (palabras clave) |
Devuelve todas las claves de perfil de palabra clave según el "nombre de grupo" proporcionado. |
| Obtener estado de registro (BPM) |
Obtener el estado del registro BPM para uno o varios registros para incluir el estado actual, que es responsable del registro, el historial de flujo de trabajo y otra información para describir el estado actual y las reglas del registro |
| Obtener etiqueta por valor (palabras clave) |
Devuelve una etiqueta de palabra clave basada en la "clave-perfil" y "clave-valor" proporcionada. |
| Obtener por clave de perfil (BPM) |
Obtenga el perfil BPM completo con la configuración y las opciones del proceso. |
| Obtener por clave de perfil (palabras clave) |
Devuelve pares clave-valor de un perfil de palabra clave específico basado en la "clave-perfil" proporcionada. |
| Obtener rol (roles) |
Obtenga las personas responsables que están asignadas a roles en el portal de administración de Agilit-e. Estos roles no solo son relevantes para registros específicos o procesos empresariales y se usan más normalmente para roles de toda la empresa en la organización. |
| Obtener roles asignados (roles) |
Obtener las personas responsables del rol asignado previamente para un registro específico |
| Obtener valor por etiqueta (palabras clave) |
Devuelve un valor de palabra clave basado en la "clave-perfil" y "label-key" proporcionada. |
| Registrar registro bpm (BPM) |
Registre un nuevo registro BPM. El registro se asigna con un recordID que se usa para el ciclo de vida del registro para identificar el registro, es el progreso, el historial y el estado en todo momento. |
Asignar rol (roles)
Asigne el rol especificado por el usuario que sea aplicable a un registro específico. Un ejemplo de esto sería un revisor de documentos o un aprobador de permisos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de proceso
|
process-key | True | string |
Clave única para el perfil de destino |
|
Identificador de registro BPM
|
bpm-record-id | True | string |
Identifica el registro para el que se va a establecer el rol. La API registerBPMRecord registra el identificador para nuevos registros y se puede encontrar en la propiedad recordID de las respuestas de la API BPM. |
|
Usuario actual
|
current-user | True | string |
Dirección de correo electrónico del usuario que establece el rol. Normalmente, será el usuario que ha iniciado sesión en el momento de llamar a la API. |
|
Nombre del rol
|
role-name | True | string |
Nombre del rol que se va a asignar. Por ejemplo, aprobador o revisor |
|
Usuarios responsables
|
responsible-users | True | string |
Las direcciones de correo electrónico de los usuarios que se asignan a este rol: (independientes mediante comas) |
Devoluciones
datos
- datos
- object
Ejecutar (BPM)
Envía una opción en su paso de flujo de trabajo actual. En función de las reglas de negocio, el registro se avanzará al siguiente paso del proceso y devolverá información sobre el siguiente paso a la API que realiza la llamada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de proceso
|
process-key | True | string |
Clave única para el perfil de destino |
|
Identificador de registro BPM
|
bpm-record-id | True | string |
Identifica el registro que se envía. La API registerBPMRecord registra el identificador para nuevos registros y se puede encontrar en la propiedad recordID de las respuestas de la API BPM. |
|
Opción seleccionada
|
option-selected | True | string |
Identifica la opción seleccionada por el usuario que se va a ejecutar como parte del proceso de envío. Este valor debe corresponderse con una opción de paso válida en el perfil de flujo de trabajo. |
|
Usuario actual
|
current-user | True | string |
Dirección de correo electrónico del usuario que envía el paso BPM. Normalmente, será el usuario que ha iniciado sesión en el momento de llamar a la API. |
|
Comentarios de pasos de flujo de trabajo
|
comments | string |
Pasa comentarios al proceso de ejecución que se marcará en el historial de flujo de trabajo. Normalmente se usaría si el usuario rechaza un paso o solicita más información. |
|
|
|
object |
Devoluciones
- Body
- ExecuteBPMResult
Ejecutar (plantillas)
Procesa y devuelve una plantilla de Agilit-e basada en la "clave-perfil" proporcionada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de perfil
|
profile-key | True | string |
Clave única para el perfil de destino |
|
|
object |
Devoluciones
- Body
- StdJSONResponse
Generar número (numeración)
Genera un número único basado en la "clave de perfil" proporcionada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de perfil
|
profile-key | True | string |
Clave única para el perfil de destino |
|
|
object |
Devoluciones
- Body
- StdJSONResponse
Obtener claves de perfil por grupo (palabras clave)
Devuelve todas las claves de perfil de palabra clave según el "nombre de grupo" proporcionado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de grupo
|
group-name | True | string |
Nombre de grupo usado para agrupar perfiles de palabra clave |
|
Ordenar
|
sort | string |
Parámetro opcional para ordenar el resultado de clave/valor devuelto. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obtener estado de registro (BPM)
Obtener el estado del registro BPM para uno o varios registros para incluir el estado actual, que es responsable del registro, el historial de flujo de trabajo y otra información para describir el estado actual y las reglas del registro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Claves de proceso
|
process-keys | string |
Filtre para identificar los procesos empresariales para los que se devolverán los registros. Esta clave se puede encontrar en el perfil BPM en el Portal de administración de Agilit-e : (independiente mediante comas) |
|
|
Identificadores de registro BPM
|
bpm-record-ids | string |
filtre para devolver solo registros con recordIds específicos. El recordId se registra mediante la API registerBPMRecord para los registros nuevos y se puede encontrar en la propiedad recordID de las respuestas de la API BPM: (independiente mediante comas). |
|
|
Nombres de paso
|
step-names | string |
Filtrar para devolver solo los registros que están actualmente en los pasos de flujo de trabajo especificados: (separados mediante comas) |
|
|
Usuarios responsables
|
responsible-users | string |
Filtrar para devolver solo los registros asignados actualmente a las direcciones de correo electrónico especificadas: (independientes mediante comas) |
|
|
Usuarios pertinentes
|
relevant-users | string |
Filtrar para devolver solo los registros que son relevantes para las direcciones de correo electrónico especificadas: (independientes mediante comas) |
|
|
Historial de inclusión
|
include-history | boolean |
Especifique si se debe devolver el objeto history con la información de estado del registro. |
|
|
Incluir opciones de paso
|
include-step-options | boolean |
Especifique si el objeto de opciones de paso debe devolverse con la información de estado del registro. |
|
|
Incluir objetos visibles
|
include-visible-objects | boolean |
Especifique si el objeto de objetos visibles debe devolverse con la información de estado del registro. |
Devoluciones
- Productos
- GetBPMRecordState
Obtener etiqueta por valor (palabras clave)
Devuelve una etiqueta de palabra clave basada en la "clave-perfil" y "clave-valor" proporcionada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de perfil
|
profile-key | True | string |
Clave única para el perfil de destino |
|
Clave de valor
|
value-key | True | string |
Clave de valor de la lista Etiqueta/Valor del perfil de destino |
Devoluciones
- Body
- StdJSONResponse
Obtener por clave de perfil (BPM)
Obtenga el perfil BPM completo con la configuración y las opciones del proceso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de perfil
|
profile-key | True | string |
Clave única para el perfil de destino |
Devoluciones
- Body
- GetBPMProfile
Obtener por clave de perfil (palabras clave)
Devuelve pares clave-valor de un perfil de palabra clave específico basado en la "clave-perfil" proporcionada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de perfil
|
profile-key | True | string |
Clave única para el perfil de destino |
|
Ordenar
|
sort | string |
Parámetro opcional para ordenar el resultado de clave/valor devuelto. |
Devoluciones
- Productos
- KeywordValues
Obtener rol (roles)
Obtenga las personas responsables que están asignadas a roles en el portal de administración de Agilit-e. Estos roles no solo son relevantes para registros específicos o procesos empresariales y se usan más normalmente para roles de toda la empresa en la organización.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombres de roles
|
role-names | True | string |
Especifique los nombres de rol para los que desea recuperar los usuarios responsables de ( separados mediante comas) |
|
Niveles condicionales
|
conditional-levels | string |
Especifique niveles adicionales que se pueden usar para determinar la persona correcta para el rol. Un ejemplo de un nivel podría ser un nombre de departamento (si desea recuperar el Administrador de departamento) o un nombre de producto (si desea recuperar el Administrador de productos): (independiente mediante comas). |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
responsibleUsers
|
responsibleUsers | array of string |
responsibleUsers |
Obtener roles asignados (roles)
Obtener las personas responsables del rol asignado previamente para un registro específico
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de proceso
|
process-key | True | string |
Clave única para el perfil de destino |
|
Identificador de registro BPM
|
bpm-record-id | True | string |
Identifica el registro para el que se va a establecer el rol. La API registerBPMRecord registra el identificador para nuevos registros y se puede encontrar en la propiedad recordID de las respuestas de la API BPM. |
|
Nombre del rol
|
role-names | True | string |
Roles que se van a consultar (separados mediante comas) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Nombre
|
name | string | |
|
Users
|
users | array of object | |
|
Correo Electrónico
|
users.email | string |
Obtener valor por etiqueta (palabras clave)
Devuelve un valor de palabra clave basado en la "clave-perfil" y "label-key" proporcionada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de perfil
|
profile-key | True | string |
Clave única para el perfil de destino |
|
Clave de etiqueta
|
label-key | True | string |
Clave etiqueta de la lista Etiqueta/Valor para el perfil de destino |
Devoluciones
- Body
- StdJSONResponse
Registrar registro bpm (BPM)
Registre un nuevo registro BPM. El registro se asigna con un recordID que se usa para el ciclo de vida del registro para identificar el registro, es el progreso, el historial y el estado en todo momento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de proceso
|
process-key | True | string |
Clave única para el perfil de destino |
|
Usuario actual
|
current-user | True | string |
Dirección de correo electrónico del usuario que registra el registro. Normalmente, será el usuario que ha iniciado sesión en el momento de llamar a la API. |
Devoluciones
- Body
- RegisterBPMRecord
Definiciones
ExecuteBPMResult
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Descripción del paso de proceso
|
description | string |
Descripción breve en la que se explica el paso de proceso |
|
Duración del Acuerdo de Nivel de Servicio (Horas)
|
duration | string |
Duración del Acuerdo de Nivel de Servicio en horas. Proporcione un valor de 0 si no es aplicable. |
|
Marca de eventos de paso de proceso
|
eventStamp | string |
Marca de eventos para el paso de proceso actual |
|
Instrucciones de paso
|
instructions | string |
Instrucciones para el usuario responsable durante el paso |
|
Clave de paso de proceso
|
key | string |
Clave única para identificar el paso de proceso |
|
Nombre del paso de proceso
|
name | string |
Un nombre corto para el paso de proceso |
|
Clave de perfil BPM
|
processKey | string |
Clave única para identificar el perfil bpm |
|
Fase de proceso
|
processStage | string |
Clave que define la fase de proceso del paso actual |
|
Tipo de responsabilidad
|
responsibility | string |
Responsabilidad basada en usuarios y roles |
|
Rol responsable del paso de proceso
|
responsibleRole | string |
Rol responsable del paso de proceso actual |
|
Paso de proceso: usuarios responsables
|
responsibleUsers | array of string |
Los usuarios responsables del paso de proceso actual |
|
stepOptions
|
stepOptions | array of object | |
|
Descripción de la opción paso
|
stepOptions.description | string |
Descripción breve en la que se explica la opción Paso |
|
Marca de eventos de opción paso
|
stepOptions.eventStamp | array of string |
Marca de eventos para la opción de paso actual |
|
Nombre de opción de paso
|
stepOptions.name | string |
Nombre corto para la opción paso |
|
Paso siguiente
|
stepOptions.nextStep | string |
El siguiente paso al que se enrutará el proceso de negocio. Deje vacío si no hay más pasos |
|
Notas de la opción paso
|
stepOptions.notes | string |
Notas opcionales para la opción Paso |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Id. de objeto de opción de paso
|
stepOptions.visibleObjects.id | string |
Identificador del componente al que se hace referencia en la interfaz de usuario. |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Etiqueta de tipo de opciones
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Una etiqueta para la elección seleccionada |
|
Valor de tipo de opciones
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Valor de la opción seleccionada |
|
Etiqueta de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.label | string |
Etiqueta que define el campo de entrada o el componente editable |
|
Mensajes de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Mensajes que se usarán cuando se produce un error en la validación de opciones de entrada |
|
Tipo de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.type | string |
Define el tipo de campo de entrada o componente editable que se va a usar. |
|
Is Step Option Object Editable
|
stepOptions.visibleObjects.isEditable | boolean |
¿Es el componente al que se hace referencia editable para la entrada del usuario? |
|
Is Step Option Object Obligatorio
|
stepOptions.visibleObjects.isMandatory | boolean |
¿Requiere el componente al que se hace referencia la entrada del usuario? |
|
visibleObjects
|
visibleObjects | array of object | |
|
Id. de objeto de paso de proceso
|
visibleObjects.id | string |
Identificador del componente al que se hace referencia en la interfaz de usuario. |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Etiqueta de tipo de opciones
|
visibleObjects.inputOptions.choices.label | string |
Una etiqueta para la elección seleccionada |
|
Valor de tipo de opciones
|
visibleObjects.inputOptions.choices.value | string |
Valor de la opción seleccionada |
|
Etiqueta de opciones de entrada
|
visibleObjects.inputOptions.label | string |
Etiqueta que define el campo de entrada o el componente editable |
|
Mensajes de opciones de entrada
|
visibleObjects.inputOptions.messages | array of string |
Mensajes que se usarán cuando se produce un error en la validación de opciones de entrada |
|
Tipo de opciones de entrada
|
visibleObjects.inputOptions.type | string |
Define el tipo de campo de entrada o componente editable que se va a usar. |
|
Objeto De paso de proceso editable
|
visibleObjects.isEditable | boolean |
¿Es el componente al que se hace referencia editable para la entrada del usuario? |
|
Es obligatorio el objeto de paso de proceso
|
visibleObjects.isMandatory | boolean |
¿Requiere el componente al que se hace referencia la entrada del usuario? |
GetBPMProfile
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
appAdmin
|
appAdmin | array of object | |
|
Correo electrónico de administrador de aplicaciones
|
appAdmin.email | string |
Una dirección de correo electrónico para el administrador del perfil bpm actual |
|
DIRECCIÓN URL de la aplicación BPM
|
appUrl | string |
Una dirección URL opcional para la aplicación que usa el perfil BPM actual |
|
Descripción del perfil bpm
|
description | string |
Descripción breve en la que se explica el perfil bpm |
|
Nombre del grupo de perfiles BPM
|
groupName | string |
Agrupación opcional para el perfil BPM |
|
Clave de perfil BPM
|
key | string |
Clave única para identificar el perfil bpm |
|
Nombre del perfil bpm
|
name | string |
Un nombre corto para el perfil BPM |
|
Notas del perfil bpm
|
notes | string |
Notas opcionales para el perfil BPM |
|
processSteps
|
processSteps | array of object | |
|
Descripción del paso de proceso
|
processSteps.description | string |
Descripción breve en la que se explica el paso de proceso |
|
Duración del Acuerdo de Nivel de Servicio (Horas)
|
processSteps.duration | string |
Duración del Acuerdo de Nivel de Servicio en horas. Proporcione un valor de 0 si no es aplicable. |
|
Es el primer paso
|
processSteps.firstStep | boolean |
Especifique si el registro del paso de proceso es el primer paso del proceso de negocio. |
|
Instrucciones de paso
|
processSteps.instructions | string |
Instrucciones para el usuario responsable durante el paso |
|
Clave de paso de proceso
|
processSteps.key | string |
Clave única para identificar el paso de proceso |
|
Nombre del paso de proceso
|
processSteps.name | string |
Un nombre corto para el paso de proceso |
|
Fase de proceso
|
processSteps.processStage | string |
Clave que define la fase de proceso del paso actual |
|
Dirección URL de referencia del paso de proceso
|
processSteps.referenceUrl | string |
Una dirección URL de referencia para el paso de proceso |
|
Tipo de responsabilidad
|
processSteps.responsibility | string |
Responsabilidad basada en usuarios y roles |
|
Rol responsable del paso de proceso
|
processSteps.responsibleRole | string |
Rol responsable del paso actual |
|
roleLevels
|
processSteps.roleLevels | array of string |
Niveles de rol condicional |
|
stepOptions
|
processSteps.stepOptions | array of object | |
|
Descripción de la opción paso
|
processSteps.stepOptions.description | string |
Descripción breve en la que se explica la opción Paso |
|
Nombre de opción de paso
|
processSteps.stepOptions.name | string |
Nombre corto para la opción paso |
|
Paso siguiente
|
processSteps.stepOptions.nextStep | string |
El siguiente paso al que se enrutará el proceso de negocio. Deje vacío si no hay más pasos |
|
Notas de la opción paso
|
processSteps.stepOptions.notes | string |
Notas opcionales para la opción Paso |
|
visibleObjects
|
processSteps.stepOptions.visibleObjects | array of object | |
|
Id. de objeto de opción de paso
|
processSteps.stepOptions.visibleObjects.id | string |
Identificador del componente al que se hace referencia en la interfaz de usuario. |
|
choices
|
processSteps.stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Etiqueta de tipo de opciones
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.label | string |
Una etiqueta para la elección seleccionada |
|
Valor de tipo de opciones
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.value | string |
Valor de la opción seleccionada |
|
Etiqueta de opciones de entrada
|
processSteps.stepOptions.visibleObjects.inputOptions.label | string |
Etiqueta que define el campo de entrada o el componente editable |
|
Mensajes de opciones de entrada
|
processSteps.stepOptions.visibleObjects.inputOptions.messages | array of string |
Mensajes que se usarán cuando se produce un error en la validación de opciones de entrada |
|
Tipo de opciones de entrada
|
processSteps.stepOptions.visibleObjects.inputOptions.type | string |
Define el tipo de campo de entrada o componente editable que se va a usar. |
|
Is Step Option Object Editable
|
processSteps.stepOptions.visibleObjects.isEditable | boolean |
¿Es el componente al que se hace referencia editable para la entrada del usuario? |
|
Is Step Option Object Obligatorio
|
processSteps.stepOptions.visibleObjects.isMandatory | boolean |
¿Requiere el componente al que se hace referencia la entrada del usuario? |
|
visibleObjects
|
processSteps.visibleObjects | array of object | |
|
Id. de objeto de paso de proceso
|
processSteps.visibleObjects.id | string |
Identificador del componente al que se hace referencia en la interfaz de usuario. |
|
choices
|
processSteps.visibleObjects.inputOptions.choices | array of object | |
|
Etiqueta de tipo de opciones
|
processSteps.visibleObjects.inputOptions.choices.label | string |
Una etiqueta para la elección seleccionada |
|
Valor de tipo de opciones
|
processSteps.visibleObjects.inputOptions.choices.value | string |
Valor de la opción seleccionada |
|
Etiqueta de opciones de entrada
|
processSteps.visibleObjects.inputOptions.label | string |
Etiqueta que define el campo de entrada o el componente editable |
|
Mensajes de opciones de entrada
|
processSteps.visibleObjects.inputOptions.messages | array of string |
Mensajes que se usarán cuando se produce un error en la validación de opciones de entrada |
|
Tipo de opciones de entrada
|
processSteps.visibleObjects.inputOptions.type | string |
Define el tipo de campo de entrada o componente editable que se va a usar. |
|
Objeto De paso de proceso editable
|
processSteps.visibleObjects.isEditable | boolean |
¿Es el componente al que se hace referencia editable para la entrada del usuario? |
|
Es obligatorio el objeto de paso de proceso
|
processSteps.visibleObjects.isMandatory | boolean |
¿Requiere el componente al que se hace referencia la entrada del usuario? |
|
DIRECCIÓN URL de referencia del perfil BPM
|
referenceUrl | string |
Dirección URL opcional a la que se puede hacer referencia para el perfil BPM actual |
GetBPMRecordState
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Descripción del paso de proceso
|
description | string |
Descripción breve en la que se explica el paso de proceso |
|
Duración del Acuerdo de Nivel de Servicio (Horas)
|
duration | string |
Duración del Acuerdo de Nivel de Servicio en horas. Proporcione un valor de 0 si no es aplicable. |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Nombre del historial de sellos de eventos
|
eventStampHistory.eventName | string |
Nombre del sello de eventos |
|
Marca de tiempo del historial de marcas de eventos
|
eventStampHistory.timeStamp | date-time |
Marca de tiempo de cuándo se produjo la marca de eventos. |
|
historia
|
history | array of object | |
|
Comentarios del historial
|
history.comments | string |
Comentarios opcionales agregados en el momento en que se creó la entrada Historial |
|
Rol actual del historial
|
history.currentRole | string |
Rol actual en el momento de la entrada Historial |
|
Usuario actual del historial
|
history.currentUser | string |
Usuario actual en el momento de la entrada Historial |
|
Duración del paso
|
history.duration | string |
El tiempo (en minutos) que el registro existía en el paso de proceso actual antes de ser accionado |
|
Marca de eventos del historial
|
history.eventStamp | array of string |
Sellos de eventos que se produjeron en el momento de la entrada historial |
|
Desde el paso
|
history.fromStep | string |
La clave del paso de proceso del registro BPM procede de en el momento de la entrada Historial |
|
Nombre del paso
|
history.fromStepName | string |
El nombre del paso de proceso del registro BPM procede de en el momento de la entrada Historial |
|
Opción Historial seleccionada
|
history.optionSelected | string |
La opción seleccionada al accionar el registro BPM |
|
Clave de proceso bpm del historial
|
history.processKey | string |
Clave única de proceso BPM para la entrada historial |
|
Fase del proceso de historial
|
history.processStage | string |
Fase de proceso en el momento de la entrada Historial |
|
Identificador de registro bpm del historial
|
history.recordId | string |
Identificador de registro del registro relacionado con BPM generado durante el proceso registrar registro BPM |
|
Rol responsable del historial
|
history.responsibleRole | string |
El rol responsable del registro BPM en el momento de la entrada Historial |
|
Usuarios responsables del historial
|
history.responsibleUsers | array of string |
Usuarios responsables en el momento de la entrada historial |
|
Fecha de envío del historial
|
history.submissionDate | date-time |
Fecha y hora en que se ha accionado el registro BPM |
|
Fase de proceso
|
history.toProcessStage | string |
Fase de proceso para el registro BPM en el momento de la entrada Historial |
|
Paso a paso
|
history.toStep | string |
Clave del paso de proceso para el registro BPM en el momento de la entrada historial |
|
Para el nombre del paso
|
history.toStepName | string |
Nombre del paso de proceso para el registro BPM en el momento de la entrada Historial |
|
Instrucciones de paso
|
instructions | string |
Instrucciones para el usuario responsable durante el paso |
|
Clave de paso de proceso
|
key | string |
Clave única para identificar el paso de proceso |
|
Nombre del paso de proceso
|
name | string |
Un nombre corto para el paso de proceso |
|
Clave de perfil BPM
|
processKey | string |
Clave única para identificar el perfil bpm |
|
Fase de proceso
|
processStage | string |
Clave que define la fase de proceso del paso actual |
|
Identificador de registro BPM
|
recordId | string |
Identificador de registro generado por el módulo BPM al registrar un registro BPM |
|
Referencia de registros BPM
|
recordRef | string |
Número legible generado por el módulo BPM mediante el módulo numeración al registrar un registro BPM |
|
Dirección URL de referencia del paso de proceso
|
referenceUrl | string |
Una dirección URL de referencia para el paso de proceso |
|
Rol responsable del paso de proceso
|
responsibleRole | string |
Rol responsable del paso actual |
|
Paso de proceso: usuarios responsables
|
responsibleUsers | array of string |
Usuarios responsables del paso de proceso actual |
|
roles
|
roles | array of object | |
|
Nombre del rol
|
roles.name | string |
Nombre del rol |
|
users
|
roles.users | array of object | |
|
Correo electrónico de rol
|
roles.users.email | string |
Direcciones de correo electrónico vinculadas al nombre del rol |
|
stepOptions
|
stepOptions | array of object | |
|
Descripción de la opción paso
|
stepOptions.description | string |
Descripción breve en la que se explica la opción Paso |
|
Marca de eventos de opción paso
|
stepOptions.eventStamp | array of string |
Marca de eventos para la opción de paso actual |
|
Nombre de opción de paso
|
stepOptions.name | string |
Nombre corto para la opción paso |
|
Paso siguiente
|
stepOptions.nextStep | string |
El siguiente paso al que se enrutará el proceso de negocio. Deje vacío si no hay más pasos |
|
Notas de la opción paso
|
stepOptions.notes | string |
Notas opcionales para la opción Paso |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Id. de objeto de opción de paso
|
stepOptions.visibleObjects.id | string |
Identificador del componente al que se hace referencia en la interfaz de usuario. |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Etiqueta de tipo de opciones
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Una etiqueta para la elección seleccionada |
|
Valor de tipo de opciones
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Valor de la opción seleccionada |
|
Etiqueta de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.label | string |
Etiqueta que define el campo de entrada o el componente editable |
|
Mensajes de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Mensajes que se usarán cuando se produce un error en la validación de opciones de entrada |
|
Tipo de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.type | string |
Define el tipo de campo de entrada o componente editable que se va a usar. |
|
Is Step Option Object Editable
|
stepOptions.visibleObjects.isEditable | boolean |
¿Es el componente al que se hace referencia editable para la entrada del usuario? |
|
Is Step Option Object Obligatorio
|
stepOptions.visibleObjects.isMandatory | boolean |
¿Requiere el componente al que se hace referencia la entrada del usuario? |
|
Enviado al paso
|
submittedIntoStep | date-time |
Fecha y hora en que se envió el registro BPM al paso de proceso actual |
|
Duración de la hora de destino
|
targetTimeDuration | date-time |
La fecha y hora en que el registro BPM debe ser accionado según la duración del Acuerdo de Nivel de Servicio. |
|
visibleObjects
|
visibleObjects | array of object | |
|
Id. de objeto de paso de proceso
|
visibleObjects.id | string |
Identificador del componente al que se hace referencia en la interfaz de usuario. |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Etiqueta de tipo de opciones
|
visibleObjects.inputOptions.choices.label | string |
Una etiqueta para la elección seleccionada |
|
Valor de tipo de opciones
|
visibleObjects.inputOptions.choices.value | string |
Valor de la opción seleccionada |
|
Etiqueta de opciones de entrada
|
visibleObjects.inputOptions.label | string |
Etiqueta que define el campo de entrada o el componente editable |
|
Mensajes de opciones de entrada
|
visibleObjects.inputOptions.messages | array of string |
Mensajes que se usarán cuando se produce un error en la validación de opciones de entrada |
|
Tipo de opciones de entrada
|
visibleObjects.inputOptions.type | string |
Define el tipo de campo de entrada o componente editable que se va a usar. |
|
Objeto De paso de proceso editable
|
visibleObjects.isEditable | boolean |
¿Es el componente al que se hace referencia editable para la entrada del usuario? |
|
Es obligatorio el objeto de paso de proceso
|
visibleObjects.isMandatory | boolean |
¿Requiere el componente al que se hace referencia la entrada del usuario? |
KeywordValues
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Etiqueta
|
label | string | |
|
Importancia
|
value | string |
RegisterBPMRecord
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Descripción del paso de proceso
|
description | string |
Descripción breve en la que se explica el paso de proceso |
|
Duración del Acuerdo de Nivel de Servicio (Horas)
|
duration | string |
Duración del Acuerdo de Nivel de Servicio en horas. Proporcione un valor de 0 si no es aplicable. |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Nombre del historial de sellos de eventos
|
eventStampHistory.eventName | string |
Nombre del sello de eventos |
|
Marca de tiempo del historial de marcas de eventos
|
eventStampHistory.timeStamp | date-time |
Marca de tiempo de cuándo se produjo la marca de eventos. |
|
historia
|
history | array of object | |
|
Comentarios del historial
|
history.comments | string |
Comentarios opcionales agregados en el momento en que se creó la entrada Historial |
|
Rol actual del historial
|
history.currentRole | string |
Rol actual en el momento de la entrada Historial |
|
Usuario actual del historial
|
history.currentUser | string |
Usuario actual en el momento de la entrada Historial |
|
Duración del paso
|
history.duration | string |
El tiempo (en minutos) que el registro existía en el paso de proceso actual antes de ser accionado |
|
Marca de eventos del historial
|
history.eventStamp | array of string |
Sellos de eventos que se produjeron en el momento de la entrada historial |
|
Desde el paso
|
history.fromStep | string |
La clave del paso de proceso del registro BPM procede de en el momento de la entrada Historial |
|
Nombre del paso
|
history.fromStepName | string |
El nombre del paso de proceso del registro BPM procede de en el momento de la entrada Historial |
|
Opción Historial seleccionada
|
history.optionSelected | string |
La opción seleccionada al accionar el registro BPM |
|
Clave de proceso bpm del historial
|
history.processKey | string |
Clave única de proceso BPM para la entrada historial |
|
Fase del proceso de historial
|
history.processStage | string |
Fase de proceso en el momento de la entrada Historial |
|
Identificador de registro bpm del historial
|
history.recordId | string |
Identificador de registro del registro relacionado con BPM generado durante el proceso registrar registro BPM |
|
Rol responsable del historial
|
history.responsibleRole | string |
El rol responsable del registro BPM en el momento de la entrada Historial |
|
Usuarios responsables del historial
|
history.responsibleUsers | array of string |
Usuarios responsables en el momento de la entrada historial |
|
Fecha de envío del historial
|
history.submissionDate | date-time |
Fecha y hora en que se ha accionado el registro BPM |
|
Fase de proceso
|
history.toProcessStage | string |
Fase de proceso para el registro BPM en el momento de la entrada Historial |
|
Paso a paso
|
history.toStep | string |
Clave del paso de proceso para el registro BPM en el momento de la entrada historial |
|
Para el nombre del paso
|
history.toStepName | string |
Nombre del paso de proceso para el registro BPM en el momento de la entrada Historial |
|
Instrucciones de paso
|
instructions | string |
Instrucciones para el usuario responsable durante el paso |
|
Clave de paso de proceso
|
key | string |
Clave única para identificar el paso de proceso |
|
Nombre del paso de proceso
|
name | string |
Un nombre corto para el paso de proceso |
|
Clave de perfil BPM
|
processKey | string |
Clave única para identificar el perfil bpm |
|
Fase de proceso
|
processStage | string |
Clave que define la fase de proceso del paso actual |
|
Identificador de registro BPM
|
recordId | string |
Identificador de registro generado por el módulo BPM al registrar un registro BPM |
|
Referencia de registros BPM
|
recordRef | string |
Número legible generado por el módulo BPM mediante el módulo numeración al registrar un registro BPM |
|
Dirección URL de referencia del paso de proceso
|
referenceUrl | string |
Una dirección URL de referencia para el paso de proceso |
|
Rol responsable del paso de proceso
|
responsibleRole | string |
Rol responsable del paso de proceso actual |
|
Paso de proceso: usuarios responsables
|
responsibleUsers | array of string |
Los usuarios responsables del paso de proceso actual |
|
roles
|
roles | array of object | |
|
Nombre del rol
|
roles.name | string |
Nombre del rol |
|
users
|
roles.users | array of object | |
|
Correo electrónico de rol
|
roles.users.email | string |
Direcciones de correo electrónico vinculadas al nombre del rol |
|
stepOptions
|
stepOptions | array of object | |
|
Descripción de la opción paso
|
stepOptions.description | string |
Descripción breve en la que se explica la opción Paso |
|
Marca de eventos de opción paso
|
stepOptions.eventStamp | array of string |
Marca de eventos para la opción de paso actual |
|
Nombre de opción de paso
|
stepOptions.name | string |
Nombre corto para la opción paso |
|
Paso siguiente
|
stepOptions.nextStep | string |
El siguiente paso al que se enrutará el proceso de negocio. Deje vacío si no hay más pasos |
|
Notas de la opción paso
|
stepOptions.notes | string |
Notas opcionales de la opción Paso |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Id. de objeto de opción de paso
|
stepOptions.visibleObjects.id | string |
Identificador del componente al que se hace referencia en la interfaz de usuario. |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Etiqueta de tipo de opciones
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Una etiqueta para la elección seleccionada |
|
Valor de tipo de opciones
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Valor de la opción seleccionada |
|
Etiqueta de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.label | string |
Etiqueta que define el campo de entrada o el componente editable |
|
Mensajes de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Mensajes que se usarán cuando se produce un error en la validación de opciones de entrada |
|
Tipo de opciones de entrada
|
stepOptions.visibleObjects.inputOptions.type | string |
Define el tipo de campo de entrada o componente editable que se va a usar. |
|
Is Step Option Object Editable
|
stepOptions.visibleObjects.isEditable | boolean |
¿Es el componente al que se hace referencia editable para la entrada del usuario? |
|
Is Step Option Object Obligatorio
|
stepOptions.visibleObjects.isMandatory | boolean |
¿Requiere el componente al que se hace referencia la entrada del usuario? |
|
visibleObjects
|
visibleObjects | array of object | |
|
Id. de objeto de paso de proceso
|
visibleObjects.id | string |
Identificador del componente al que se hace referencia en la interfaz de usuario. |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Etiqueta de tipo de opciones
|
visibleObjects.inputOptions.choices.label | string |
Una etiqueta para la elección seleccionada |
|
Valor de tipo de opciones
|
visibleObjects.inputOptions.choices.value | string |
Valor de la opción seleccionada |
|
Etiqueta de opciones de entrada
|
visibleObjects.inputOptions.label | string |
Etiqueta que define el campo de entrada o el componente editable |
|
Mensajes de opciones de entrada
|
visibleObjects.inputOptions.messages | array of string |
Mensajes que se usarán cuando se produce un error en la validación de opciones de entrada |
|
Tipo de opciones de entrada
|
visibleObjects.inputOptions.type | string |
Define el tipo de campo de entrada o componente editable que se va a usar. |
|
Objeto De paso de proceso editable
|
visibleObjects.isEditable | boolean |
¿Es el componente al que se hace referencia editable para la entrada del usuario? |
|
Es obligatorio el objeto de paso de proceso
|
visibleObjects.isMandatory | boolean |
¿Requiere el componente al que se hace referencia la entrada del usuario? |
StdJSONResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Resultado
|
result | string |
Resultado |
objeto
Este es el tipo 'objeto'.