SIGNL4: alertas móviles
SIGNL4 ofrece alertas móviles críticas, respuesta a incidentes y distribución de servicios para la infraestructura crítica para el funcionamiento. Le avisa de forma persistente a través de llamadas de inserción de aplicaciones, texto SMS y voz, como seguimiento, escalación, colaboración y planificación de deberes.
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 | Derdack GmbH |
| URL | https://www.signl4.com/feedback-we-love-hear-from-you/ |
| Correo Electrónico | success@signl4.com |
| Metadatos del conector | |
|---|---|
| Publicador | Derdack |
| Sitio web | https://www.signl4.com |
| Directiva de privacidad | https://www.signl4.com/privacy-policy/ |
| Categorías | Operaciones de TI; Comunicación |
SIGNL4 ofrece alertas críticas, respuesta a incidentes y distribución de servicios para la infraestructura crítica para el funcionamiento. Le avisa de forma persistente a través de llamadas de inserción de aplicaciones, texto SMS y voz, como seguimiento, escalación, colaboración y planificación de deberes.
Puede integrar SIGNL4 en el flujo para enviar alertas de equipo confiables siempre que sea necesario.
Prerrequisitos
Necesita una cuenta SIGNL4. Si aún no tiene uno, puede obtener uno en https://connect.signl4.com/. También puedes descargar directamente la aplicación móvil desde Google Play Store o desde apple App Store.
Obtención de credenciales
Para usar el conector, necesita la clave de API SIGNL4. En el portal web SIGNL4, obtendrá la clave de API en Integrations - API Key (Integraciones:> clave de API). Después, puede usar la clave de API para autenticar el conector SIGNL4 en Power Automate.
Introducción al conector
Puede encontrar una descripción detallada de las funciones de LA API SIGNL4 aquí. Después de agregar el conector SIGNL4 al flujo de Power Automate, debe obtener la clave de API SIGNL4. A continuación, puede usar las funciones de API en consecuencia. Si debe tener más preguntas, no dude en ponerse en contacto con el equipo de SIGNL4.
La manera más fácil de empezar es usar la acción EventsSend para enviar una alerta:
- En primer lugar, obtenga el secreto del equipo signl4 o el secreto de integración desde el portal web de SIGNL4.
- Cuando tenga el secreto de equipo o el secreto de integración, puede usar este en la función EventsSend para desencadenar un evento que pueda generar una alerta para el equipo. Solo tiene que escribir cualquier título y mensaje. Puede encontrar una descripción de los otros parámetros en la página de documentación del webhook de entrada.
- Es así y ahora desencadena un evento y recibe una alerta en SIGNL4.
Problemas y limitaciones conocidos
El conector SIGNL4 para Power Automate encapsula toda la API REST SIGNL4 2.0. Algunas funcionalidades dependen del plan SIGNL4.
Errores y soluciones comunes
N/A
Preguntas más frecuentes
Puede encontrar las preguntas más frecuentes de SIGNL4 y la ayuda en línea aquí. También hay una biblioteca de vídeo completa disponible.
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 |
|---|---|---|---|
| Clave de API | securestring | La clave de API de esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Acknowlegde multiple alerts (Acknowlegde multiple alerts) |
Este método confirma todas las alertas proporcionadas. |
| Actualiza el perfil de equipo de un equipo. |
Actualiza el perfil de equipo de un equipo. |
| Actualiza el perfil de usuario de un usuario. |
Actualiza el perfil de usuario de un usuario. |
| Actualiza la contraseña de un usuario. |
Actualiza la contraseña de un usuario. |
| Actualiza los datos personalizados de una instancia de script determinada que incluye su nombre para mostrar. |
Actualiza la instancia de script especificada. |
| Actualiza un perfil de suscripciones. |
Actualiza un perfil de suscripciones. |
| Actualiza una acción remota |
Solicitud de ejemplo:
|
| Actualiza una instancia de script determinada. |
Actualiza la instancia de script especificada, que normalmente se usa para actualizar la configuración de un script. |
| Actualización de la configuración de prepago actual de la suscripción |
Actualice la configuración de prepago actual de la suscripción. |
| Actualización de la configuración de prepago actual de una suscripción |
Actualice la configuración de prepago actual de una suscripción. |
| Actualización de la plantilla de llamada existente para la suscripción |
Actualice la plantilla de llamada existente para la suscripción. |
| Actualización de un origen de eventos |
Actualice un origen de eventos. |
| Actualización de un patrón de alertas existente |
Actualice un patrón de alerta existente. |
| Actualizar información de configuración regional (por ejemplo, idioma, zona horaria) para el usuario |
Actualice la información de configuración regional (por ejemplo, idioma, zona horaria) para el usuario. |
| Actualizar la configuración de privacidad de un equipo |
Actualice la configuración de privacidad de un equipo. |
| Actualizar la pertenencia al equipo del usuario |
Actualiza la pertenencia al equipo del usuario. Puede mover el usuario a otro equipo dentro de la suscripción o cambiar el rol del usuario. |
| Actualizar una categoría existente |
Solicitud de ejemplo:
|
| Actualizar webhook por identificador |
Actualiza el webhook especificado. |
| Agregar usuario a un equipo |
Agregue un usuario a un equipo. |
| Alerta de desencadenador |
Desencadena una nueva alerta para el equipo. Todos los miembros del equipo en servicio recibirán notificaciones de alerta. |
| Anotación de alerta |
Anota una alerta dada por la información de anotación. |
|
Capacidad de deshabilitar un web |
Capacidad de deshabilitar un webHook. |
|
Capacidad de habilitar un web |
Capacidad de habilitar un webHook. |
| Carga de una imagen de perfil para un equipo especificado |
Cargó una imagen de perfil para un equipo especificado. |
| Carga de una imagen de perfil para un usuario especificado |
Cargó una imagen de perfil para un usuario especificado. |
| Cerrar una alerta |
Cierre una alerta. |
| Cerrar varias alertas |
Este método cierra todas las alertas proporcionadas. |
| Cierre todas las alertas confirmadas |
Este método cierra todas las alertas confirmadas que el equipo tiene actualmente. |
| Comprueba si un usuario tiene el permiso proporcionado. |
Comprueba si un usuario tiene el permiso proporcionado. |
| Confirma todas las alertas visibles |
Este método confirma todas las alertas no controladas que el equipo tiene actualmente por un usuario específico. |
| Confirmación de una alerta |
Confirme una alerta. |
| Copiar días festivos de un equipo a otro |
Copie los días festivos de un equipo a otro. |
| Crea una nueva instancia de script en el equipo de SIGNL4 |
Crea una nueva instancia de script del script especificado en el cuerpo de la solicitud. |
| Creación de nuevas plantillas de llamada para la suscripción |
Cree nuevas plantillas de llamada para la suscripción. |
| Creación de un nuevo patrón de alertas |
Cree un nuevo patrón de alertas. |
| Creación de un nuevo trabajo remoto |
Solicitud de ejemplo:
|
| Creación de un origen de eventos |
Cree el origen del evento. |
| Creación de webhook |
Crea un nuevo webhook saliente que se notificará cuando se produzcan determinados eventos. |
| Crear o actualizar una programación de deber determinada |
Crear o actualizar una programación de deber determinada. |
| Crear una categoría nueva |
Solicitud de ejemplo:
|
| Crear una nueva acción remota |
Solicitud de ejemplo:
|
|
Descargar informe de derechos con un file |
Descargue el informe de derechos con un fileName específico. |
| Deshabilita una instancia de script determinada. |
Deshabilita una instancia de script determinada. |
| Deshacer cola de varias confirmaciones |
Este método intenta deshacer la confirmación de varias alertas a través de una cola. La operación se controla en segundo plano. |
| Deshacer el cierre de una alerta |
Este método intenta deshacer un cierre de alerta. |
| Deshacer la confirmación de una alerta |
Este método intenta deshacer una confirmación de alerta. |
| Devuelve acciones remotas |
Solicitud de ejemplo:
|
| Devuelve el informe de alertas. |
Devuelve el informe de alertas. |
| Devuelve información de la programación de deberes con el identificador especificado. |
Devuelve información de la programación de deberes con el identificador especificado. |
| Devuelve información sobre todas las programaciones planeadas. |
Devuelve información sobre todas las programaciones planeadas. |
| Devuelve la información de precios del canal de la suscripción. |
Devuelve la información de precios del canal de la suscripción. |
| Devuelve las características de una suscripción especificada. |
Devuelve las características de una suscripción especificada. |
| Devuelve toda la información sobre una instancia de script determinada. |
Obtiene la instancia de script especificada por el identificador de instancia pasado. |
| Devuelve todas las instancias de script del equipo SIGNL4. |
Devuelve todas las instancias de script de la suscripción. |
| Devuelve todos los scripts de inventario disponibles. |
Devuelve todos los scripts de inventario disponibles que se pueden agregar a una suscripción SIGNL4. |
| Devuelve todos los scripts de inventario. |
Devuelve todos los scripts de inventario. |
| Devuelve trabajos remotos paginados desde diario |
Solicitud de ejemplo:
|
| Devuelve un script de inventario por su identificador |
Obtiene el script especificado por el identificador de script pasado. |
| Devuelve un trabajo remoto del diario |
Solicitud de ejemplo:
|
| Devuelve una acción remota |
Solicitud de ejemplo:
|
| Elimina la cuenta de usuario. |
Elimina la cuenta de usuario. |
| Elimina la imagen actual del equipo. |
Elimina la imagen actual del equipo. |
| Elimina una acción remota |
Solicitud de ejemplo:
|
| Elimina una instancia de script. |
Obtiene la instancia de script especificada por el identificador de instancia pasado. |
| Eliminación de programaciones de deberes en el intervalo |
Elimina las programaciones de deber en el intervalo. |
| Eliminación de un origen de eventos |
Elimine un origen de eventos. |
| Eliminación de un patrón de alerta específico |
Elimine un patrón de alerta específico. |
| Eliminación de una distribución de eventos |
Eliminar una distribución de eventos. |
| Eliminación de una plantilla de llamada existente de la suscripción |
Elimine la plantilla de llamada existente de la suscripción. |
| Eliminar días festivos |
Eliminar días festivos. |
| Eliminar el número de teléfono de un usuario |
Elimine el número de teléfono de un usuario. |
| Eliminar imagen de usuario personal |
Eliminar imagen de usuario personal. |
| Eliminar un deber específico |
Elimine un deber específico. |
| Eliminar una categoría existente |
Solicitud de ejemplo:
|
| Eliminar una dirección de contacto de un usuario |
Elimina una dirección de contacto de un usuario. |
| Eliminar webhook por identificador |
Elimina el webhook especificado para que ya no se le notifique. |
| Envía de nuevo un correo electrónico de invitación si existe una invitación. |
Envía de nuevo un correo electrónico de invitación si existe una invitación. |
| Envía un correo a un usuario especificado. |
Envía un correo a un usuario especificado que contiene información de todos los orígenes de eventos del equipo del usuario. |
| Escalado manual de una alerta a un equipo |
Escale manualmente una alerta a un equipo. |
| Establece la configuración de alerta de un equipo específico |
Establece la configuración de alerta de un equipo específico. |
| Establecer el número de teléfono de un usuario |
Establezca el número de teléfono de un usuario. Si se guarda otro número de teléfono, se sobrescribirá. |
| Establecimiento de la ubicación de un usuario |
Establecer la ubicación de un usuario. |
| Establecimiento de perfiles de notificación para el usuario |
Establecer perfiles de notificación para el usuario. |
| Establecimiento de suscripciones de categoría |
Solicitud de ejemplo:
|
| Evento Send |
Evento de envío. |
| Guardar días festivos para un equipo |
Guardar vacaciones para un equipo. |
| Guardar días festivos repetidos para un equipo |
Guarde los días festivos repetidos para un equipo. |
| Guardar varias programaciones |
Guarde varias programaciones. Si lo desea, es posible invalidar las programaciones existentes. |
| Habilita una instancia de script |
Habilita una instancia de script. |
| Invitar a usuarios a un equipo |
Invite a los usuarios a un equipo. |
| Obtención de entradas de escala de tiempo de alerta |
Obtiene las entradas de la escala de tiempo de alerta de una alerta por identificador. |
| Obtención de la configuración de deberes de equipo para varios equipos |
Obtenga la configuración de deberes de equipo para varios equipos. |
| Obtención de la configuración de prepago actual de la suscripción |
Obtenga la configuración de prepago actual de la suscripción. |
| Obtención de métricas para todas las categorías |
Solicitud de ejemplo:
|
| Obtención de métricas para una categoría específica |
Solicitud de ejemplo:
|
| Obtención de notificaciones de alertas |
Obtenga notificaciones de todos los usuarios por identificador de alerta. |
| Obtención de orígenes de eventos de uno o varios equipos |
Obtenga orígenes de eventos de uno o varios equipos. |
| Obtención de parámetros de evento |
Obtiene los parámetros de un evento por identificador. |
| Obtención de perfiles de notificación para el usuario |
Obtener perfiles de notificación para el usuario. |
| Obtención de pertenencias a equipos de un usuario |
Obtener pertenencias a equipos de un usuario. |
| Obtención de pertenencias a equipos por equipo |
Obtener pertenencias a equipos por equipo. |
| Obtención de todos los patrones de alertas del equipo |
Obtenga todos los patrones de alerta del equipo. |
| Obtención de todos los usuarios de equipos especificados |
Obtener todos los usuarios de los equipos especificados. |
| Obtención de una imagen de usuario personal |
Obtenga una imagen de usuario personal. |
| Obtención del estado del deber por identificador de usuario |
Devuelve un objeto con información de deber. |
| Obtención del evento de información general paginado |
Obtener información general sobre eventos paginados. Si hay más resultados, también obtendrá un token de continuación que puede agregar al filtro de eventos. |
| Obtención del origen del evento por identificador |
Obtenga el origen del evento por identificador. |
| Obtención del saldo de prepago actual de la suscripción |
Obtenga el saldo de prepago actual de la suscripción. |
| Obtener detalles de un evento |
Obtenga detalles de un evento. |
| Obtener detalles sobre una alerta |
Obtenga detalles sobre una alerta. |
| Obtener días festivos para el equipo |
Obtener días festivos para el equipo. |
| Obtener el saldo prepago actual de una suscripción |
Obtenga el saldo de prepago actual de una suscripción. |
| Obtener información de datos adjuntos de una alerta |
Obtener datos adjuntos de una alerta por identificador. |
| Obtener información de todas las suscripciones disponibles y administradas |
Obtenga información de todas las suscripciones disponibles o administradas. |
| Obtener información de todos los equipos |
Obtenga información de todos los equipos. |
| Obtener información de una suscripción específica |
Obtiene información de una suscripción específica. |
| Obtener información del asistente de servicio para equipos |
Obtenga información del asistente de servicio para los equipos. |
| Obtener información general del evento |
Obtenga información general del evento por identificador. |
| Obtener información para todos los equipos de la suscripción |
Obtenga información para todos los equipos de la suscripción. |
| Obtener información pública sobre todos los equipos de una suscripción |
Obtenga información pública sobre todos los equipos de una suscripción. |
| Obtener información sobre los informes de alertas descargables |
Obtenga información sobre los informes de alertas descargables. |
| Obtener informe de alertas |
Devuelve información sobre el volumen de alertas ocurrido en diferentes períodos de tiempo, así como información sobre el comportamiento de respuesta (cantidad de alertas confirmadas y no controladas) de los miembros del equipo. |
| Obtener la configuración de prepago actual de una suscripción |
Obtenga la configuración de prepago actual de una suscripción. |
| Obtener la configuración de privacidad del equipo para un equipo |
Obtiene la configuración de privacidad del equipo para un equipo. |
| Obtener las transacciones de prepago de la suscripción |
Obtenga las transacciones de prepago de la suscripción. |
| Obtener las transacciones de prepago de una suscripción |
Obtiene las transacciones de prepago de una suscripción. |
| Obtener suscripciones de categoría |
Solicitud de ejemplo:
|
| Obtener todas las categorías |
Obtiene todas las categorías. |
| Obtener todas las categorías |
Solicitud de ejemplo:
|
| Obtener todas las plantillas de llamada de la suscripción |
Obtenga todas las plantillas de llamada de la suscripción. |
| Obtener todos los equipos de los que es miembro el usuario |
Devuelve una lista de objetos de equipo con detalles como su nombre. Solo se devolverán los equipos de los que sea miembro el usuario. |
| Obtener todos los usuarios |
Devuelve una lista de objetos de usuario con detalles como su dirección de correo electrónico e información de servicio. Solo se devolverán los usuarios a los que tenga acceso. |
| Obtener una alerta |
Obtiene una alerta por identificador. |
| Obtener una categoría específica |
Solicitud de ejemplo:
|
| Obtener usuario por identificador |
Devuelve un objeto de usuario con detalles como su dirección de correo electrónico e información de deber. |
| Obtener webhook por identificador |
Devuelve información del webhook especificado por el identificador pasado. |
| Obtener webhooks |
Devuelve una colección de webhooks salientes definidos en el sistema. |
| Obtiene alertas paginadas. |
Obtiene alertas paginadas. |
| Obtiene el progreso de la configuración de un equipo específico. |
Obtiene el progreso de la configuración de un equipo específico. |
| Obtiene el progreso de la configuración de un usuario específico. |
Obtiene el progreso de la configuración de un usuario específico. |
| Obtiene información de un equipo específico. |
Obtiene información de un equipo específico. |
| Obtiene la configuración de alerta de un equipo específico. |
Obtiene la configuración de alerta de un equipo específico. |
| Obtiene la configuración de alerta de un equipo específico. |
Obtiene la configuración de alerta de un equipo específico. |
| Obtiene la imagen de un equipo especificado. |
Obtiene la imagen de un equipo especificado. |
| Obtiene las licencias de número de voz de una suscripción. |
Obtiene las licencias de número de voz de una suscripción. |
| Obtiene las licencias de usuario de una suscripción. |
Obtiene las licencias de usuario de una suscripción. |
| Obtiene los nombres de todas las imágenes de categoría de alerta. |
Obtiene los nombres de todas las imágenes de categoría de alerta. Para obtener la imagen, vaya a account.signl4.com/images/alerts/categoryImageName.svg. |
| Obtiene orígenes de eventos de un equipo específico. |
Obtiene orígenes de eventos de un equipo específico. |
| Obtiene un archivo adjunto especificado de una alerta especificada. |
Obtiene un archivo adjunto especificado de una alerta especificada. |
| Puntee al usuario |
El usuario especificado se perforará del deber. |
| Puntee al usuario como administrador |
El usuario especificado se perforará como administrador. |
| Puntee al usuario en |
El usuario especificado se perforará en el deber. |
| Quita un usuario o una invitación de un equipo |
Quita un usuario o una invitación de un equipo. |
| Recuperación de una definición |
Recuperar una definición. |
| Recuperar toda la definición disponible |
Recupere toda la definición disponible. |
| Retirar el cierre de varias alertas |
Este método intenta deshacer varios cierres de alerta. La operación se controla en segundo plano. |
| Valida un número de teléfono creado anteriormente para un usuario |
Valida un número de teléfono creado anteriormente para un usuario. |
| Validación de intervalos de tiempo de un patrón |
Valide una ranura de tiempo de un patrón en todos los intervalos de tiempo existentes de otros patrones. |
Acknowlegde multiple alerts (Acknowlegde multiple alerts)
Este método confirma todas las alertas proporcionadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Actualiza el perfil de equipo de un equipo.
Actualiza el perfil de equipo de un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo que se debe actualizar. |
|
nombre
|
name | string |
Devoluciones
- Body
- TeamInfo
Actualiza el perfil de usuario de un usuario.
Actualiza el perfil de usuario de un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario que se va a actualizar. |
|
nombre
|
name | string | ||
|
timeZone
|
timeZone | string |
Devoluciones
- Body
- UserInfo
Actualiza la contraseña de un usuario.
Actualiza la contraseña de un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador de usuario del usuario cuya contraseña se debe cambiar. |
|
currentPassword
|
currentPassword | string | ||
|
newPassword
|
newPassword | string |
Actualiza los datos personalizados de una instancia de script determinada que incluye su nombre para mostrar.
Actualiza la instancia de script especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de instancia de script
|
instanceId | True | string |
Identificador de instancia del script que se va a actualizar. |
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
instanceId
|
instanceId | string | ||
|
scriptName
|
scriptName | string |
Devoluciones
Actualiza un perfil de suscripciones.
Actualiza un perfil de suscripciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción que se va a actualizar |
|
nombre
|
name | string |
Devoluciones
- Body
- SubscriptionInfo
Actualiza una acción remota
Solicitud de ejemplo:
PUT /remoteActions/{actionId}
{
"teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
"name": "MyAction",
"enabled": true,
}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de la acción
|
actionId | True | string |
Identificador de la acción remota que se va a actualizar |
|
Id. de la acción
|
language | integer |
|
|
|
nombre
|
name | True | string | |
|
value
|
value | string | ||
|
canEdit
|
canEdit | boolean | ||
|
canExecute
|
canExecute | boolean | ||
|
teamId
|
teamId | string | ||
|
definitionId
|
definitionId | string | ||
|
descripción
|
description | string | ||
|
enabled
|
enabled | boolean | ||
|
nombre
|
name | string | ||
|
teamId
|
teamId | string |
Devoluciones
Actualiza una instancia de script determinada.
Actualiza la instancia de script especificada, que normalmente se usa para actualizar la configuración de un script.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de instancia de script
|
instanceId | True | string |
Identificador de instancia del script que se va a actualizar. |
|
config
|
config | |||
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
enabled
|
enabled | boolean | ||
|
teamId
|
teamId | string |
Devoluciones
Actualización de la configuración de prepago actual de la suscripción
Actualice la configuración de prepago actual de la suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
topUpAmount
|
topUpAmount | integer | ||
|
topUpEnabled
|
topUpEnabled | boolean | ||
|
topUpLimit
|
topUpLimit | integer |
Devoluciones
- Body
- PrepaidSettingsInfo
Actualización de la configuración de prepago actual de una suscripción
Actualice la configuración de prepago actual de una suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción |
|
topUpAmount
|
topUpAmount | integer | ||
|
topUpEnabled
|
topUpEnabled | boolean | ||
|
topUpLimit
|
topUpLimit | integer |
Devoluciones
- Body
- PrepaidSettingsInfo
Actualización de la plantilla de llamada existente para la suscripción
Actualice la plantilla de llamada existente para la suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de plantilla
|
templateId | True | string |
Identificador de plantilla que desea actualizar |
|
categoryId
|
categoryId | string | ||
|
ID externo
|
externalId | string | ||
|
id
|
id | string | ||
|
location
|
location | string | ||
|
nombre
|
name | string | ||
|
Asunto
|
subject | string | ||
|
targetAllTeams
|
targetAllTeams | boolean | ||
|
targetTeamId
|
targetTeamId | string | ||
|
texto
|
text | string | ||
|
workflowType
|
workflowType | integer |
|
Devoluciones
- response
- array of V2.CalloutTemplateDetails
Actualización de un origen de eventos
Actualice un origen de eventos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de origen del evento
|
eventSourceId | True | string |
Identificador del origen del evento |
|
descripción
|
description | string | ||
|
disabled
|
disabled | boolean | ||
|
nombre
|
name | string | ||
|
teamId
|
teamId | string |
Devoluciones
Actualización de un patrón de alertas existente
Actualice un patrón de alerta existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo para el que desea crear el patrón |
|
Id. de patrón
|
patternId | True | string |
Identificador de patrón de patrón que se va a actualizar |
|
categories
|
categories | array of string | ||
|
enabled
|
enabled | boolean | ||
|
mode
|
mode | integer |
|
|
|
referenceId
|
referenceId | string | ||
|
id
|
id | string | ||
|
nombre
|
name | string | ||
|
Canal
|
channel | integer |
|
|
|
delayInMinutes
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | ||
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
overrideResponseSettings
|
overrideResponseSettings | boolean | ||
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer | ||
|
suppressSignl
|
suppressSignl | boolean | ||
|
hora
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
día laborable
|
weekday | integer |
|
|
|
id
|
id | string |
Devoluciones
Actualizar información de configuración regional (por ejemplo, idioma, zona horaria) para el usuario
Actualice la información de configuración regional (por ejemplo, idioma, zona horaria) para el usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id. de usuario, correo electrónico o "me" para el usuario que desea actualizar |
|
lenguaje
|
language | string | ||
|
timeZone
|
timeZone | string |
Devoluciones
Actualizar la configuración de privacidad de un equipo
Actualice la configuración de privacidad de un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo |
|
hideContactAddresses
|
hideContactAddresses | boolean | ||
|
hideDutyData
|
hideDutyData | boolean | ||
|
hideForEscalation
|
hideForEscalation | boolean |
Devoluciones
Actualizar la pertenencia al equipo del usuario
Actualiza la pertenencia al equipo del usuario. Puede mover el usuario a otro equipo dentro de la suscripción o cambiar el rol del usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Team the user you want to update belongs to at the moment. |
|
Id. de usuario
|
userId | True | string |
Identificador de usuario del usuario que desea actualizar. |
|
Id. de usuario
|
requesterUserId | string |
Identificador de usuario del usuario con el que desea cambiar el rol. Debe proporcionarse al usar una clave de API. Este usuario debe tener el administrador de roles (para establecer el rol de administrador) o el administrador del equipo (para establecer derechos. |
|
|
Establecer user on duty
|
setUserOnDuty | boolean |
Establece el nuevo estado de deber para el usuario si el usuario se mueve a otro equipo. El usuario está en servicio de forma predeterminada. |
|
|
isValid
|
isValid | boolean | ||
|
roleId
|
roleId | string | ||
|
teamId
|
teamId | string |
Devoluciones
- Body
- UserInfo
Actualizar una categoría existente
Solicitud de ejemplo:
PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
"name": "Water-Updated",
"imageName": "water.svg",
"color": "#0000cc",
"keywordMatching": "All",
"keywords": [
{
"value": "H2O"
},
{
"value": "Water"
},
{
"value": "Wet"
}
]
}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenece la categoría |
|
Id. de categoría
|
categoryId | True | string |
Id. de categoría |
|
enabled
|
enabled | boolean | ||
|
id
|
id | string | ||
|
nombre
|
name | string | ||
|
type
|
type | True | integer |
|
|
value
|
value | string | ||
|
color
|
color | True | string | |
|
id
|
id | string | ||
|
nombre
|
name | string | ||
|
type
|
type | True | integer |
|
|
value
|
value | string | ||
|
id
|
id | string | ||
|
imageName
|
imageName | True | string | |
|
isDefault
|
isDefault | boolean | ||
|
keywordMatching
|
keywordMatching | True | integer |
|
|
palabras clave
|
keywords | True | array of string | |
|
palabras claveExcluded
|
keywordsExcluded | array of string | ||
|
nombre
|
name | True | string | |
|
options
|
options | integer |
|
|
|
order
|
order | integer | ||
|
teamId
|
teamId | string |
Devoluciones
- Body
- CategoryInfo
Actualizar webhook por identificador
Actualiza el webhook especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de webhook saliente
|
webhookId | True | string |
Identificador del webhook de salida que se va a actualizar. |
|
descripción
|
description | string | ||
|
extUrl
|
extUrl | True | string | |
|
nombre
|
name | True | string | |
|
teamId
|
teamId | string |
Devoluciones
- Body
- WebhookInfo
Agregar usuario a un equipo
Agregue un usuario a un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. del equipo al que se debe invitar al usuario. |
|
Id. de usuario
|
userId | True | string |
Identificador del usuario que desea agregar a un equipo. |
|
roleId
|
roleId | string | ||
|
setUserOnDuty
|
setUserOnDuty | boolean |
Devoluciones
Alerta de desencadenador
Desencadena una nueva alerta para el equipo. Todos los miembros del equipo en servicio recibirán notificaciones de alerta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
nombre
|
name | string | ||
|
order
|
order | integer | ||
|
type
|
type | integer |
|
|
|
value
|
value | string | ||
|
contenido
|
content | string | ||
|
tipo de contenido
|
contentType | string | ||
|
codificación
|
encoding | integer |
|
|
|
id
|
id | string | ||
|
nombre
|
name | string | ||
|
categoría
|
category | string | ||
|
ID externo
|
externalId | string | ||
|
Banderas
|
flags | integer |
|
|
|
severity
|
severity | integer |
|
|
|
teamId
|
teamId | True | string | |
|
texto
|
text | True | string | |
|
title
|
title | True | string |
Devoluciones
- Body
- V2.AlertDetails
Anotación de alerta
Anota una alerta dada por la información de anotación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador de la alerta para anotar. |
|
texto
|
text | string | ||
|
type
|
type | integer |
|
|
|
userId
|
userId | string |
Devoluciones
Capacidad de deshabilitar un webHook
Capacidad de deshabilitar un webHook.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de webhook
|
webhookId | True | string |
Id. de webhook para webhook que se debe habilitar. |
Devoluciones
- Body
- WebhookInfo
Capacidad de habilitar un webHook
Capacidad de habilitar un webHook.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de webhook
|
webhookId | True | string |
Id. de webhook para webhook que se debe deshabilitar. |
Devoluciones
- Body
- WebhookInfo
Carga de una imagen de perfil para un equipo especificado
Cargó una imagen de perfil para un equipo especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo en el que se va a establecer la imagen del equipo. |
Carga de una imagen de perfil para un usuario especificado
Cargó una imagen de perfil para un usuario especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario. |
Cerrar una alerta
Cierre una alerta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador para confirmar una alerta. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Devoluciones
- Body
- V2.AlertInfo
Cerrar varias alertas
Este método cierra todas las alertas proporcionadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Cierre todas las alertas confirmadas
Este método cierra todas las alertas confirmadas que el equipo tiene actualmente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | string |
Id. de usuario del usuario que se va a usar para cerrar las alarmas. |
|
|
categoryIds
|
categoryIds | array of string | ||
|
maxDate
|
maxDate | date-time | ||
|
minDate
|
minDate | date-time | ||
|
scope
|
scope | integer |
|
|
|
teamIds
|
teamIds | array of string |
Comprueba si un usuario tiene el permiso proporcionado.
Comprueba si un usuario tiene el permiso proporcionado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id. del usuario para comprobar los permisos. |
|
permissions
|
permissions | array of string | ||
|
teamIds
|
teamIds | array of string |
Devoluciones
Confirma todas las alertas visibles
Este método confirma todas las alertas no controladas que el equipo tiene actualmente por un usuario específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | string |
Id. de usuario del usuario que se va a usar para confirmar las alarmas. |
|
|
categoryIds
|
categoryIds | array of string | ||
|
maxDate
|
maxDate | date-time | ||
|
minDate
|
minDate | date-time | ||
|
scope
|
scope | integer |
|
|
|
teamIds
|
teamIds | array of string |
Confirmación de una alerta
Confirme una alerta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador para confirmar una alerta. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Devoluciones
- Body
- V2.AlertInfo
Copiar días festivos de un equipo a otro
Copie los días festivos de un equipo a otro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo al que desea copiar días festivos |
|
Año
|
year | True | integer |
Año desde el que desea copiar |
|
Id. de equipo
|
sourceTeamId | True | string |
Identificador de equipo del equipo desde el que quiere copiar días festivos |
Devoluciones
Crea una nueva instancia de script en el equipo de SIGNL4
Crea una nueva instancia de script del script especificado en el cuerpo de la solicitud.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
config
|
config | |||
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
enabled
|
enabled | boolean | ||
|
instanceId
|
instanceId | string | ||
|
scriptId
|
scriptId | string | ||
|
scriptName
|
scriptName | string | ||
|
sharedTeams
|
sharedTeams | array of string | ||
|
teamId
|
teamId | string |
Devoluciones
Creación de nuevas plantillas de llamada para la suscripción
Cree nuevas plantillas de llamada para la suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
categoryId
|
categoryId | string | ||
|
ID externo
|
externalId | string | ||
|
id
|
id | string | ||
|
location
|
location | string | ||
|
nombre
|
name | string | ||
|
Asunto
|
subject | string | ||
|
targetAllTeams
|
targetAllTeams | boolean | ||
|
targetTeamId
|
targetTeamId | string | ||
|
texto
|
text | string | ||
|
workflowType
|
workflowType | integer |
|
Devoluciones
- response
- array of V2.CalloutTemplateDetails
Creación de un nuevo patrón de alertas
Cree un nuevo patrón de alertas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo para el que desea crear el patrón |
|
categories
|
categories | array of string | ||
|
enabled
|
enabled | boolean | ||
|
mode
|
mode | integer |
|
|
|
referenceId
|
referenceId | string | ||
|
id
|
id | string | ||
|
nombre
|
name | string | ||
|
Canal
|
channel | integer |
|
|
|
delayInMinutes
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | ||
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
overrideResponseSettings
|
overrideResponseSettings | boolean | ||
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer | ||
|
suppressSignl
|
suppressSignl | boolean | ||
|
hora
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
día laborable
|
weekday | integer |
|
|
|
id
|
id | string |
Devoluciones
Creación de un nuevo trabajo remoto
Solicitud de ejemplo:
POST /remoteActions/{actionId}/jobs
{
"remoteActionPin" : "1234",
"parameters": [
{
"name": "Param1",
"value": "Value 1"
}
]
}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de la acción
|
actionId | True | string |
Id. de la acción |
|
nombre
|
name | True | string | |
|
value
|
value | string | ||
|
alertId
|
alertId | string | ||
|
options
|
options | integer |
|
|
|
remoteActionPin
|
remoteActionPin | string |
Devoluciones
- Body
- V2.RemoteJob
Creación de un origen de eventos
Cree el origen del evento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
descripción
|
description | string | ||
|
disabled
|
disabled | boolean | ||
|
lenguaje
|
language | integer |
|
|
|
nombre
|
name | string | ||
|
sharedTeams
|
sharedTeams | array of string | ||
|
teamId
|
teamId | string | ||
|
type
|
type | integer |
|
Devoluciones
Creación de webhook
Crea un nuevo webhook saliente que se notificará cuando se produzcan determinados eventos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
descripción
|
description | string | ||
|
extUrl
|
extUrl | True | string | |
|
nombre
|
name | True | string | |
|
teamId
|
teamId | string |
Devoluciones
- response
- string
Crear o actualizar una programación de deber determinada
Crear o actualizar una programación de deber determinada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. del equipo al que se asignará el deber. |
|
end
|
end | date-time | ||
|
id
|
id | string | ||
|
options
|
options | integer | ||
|
start
|
start | date-time | ||
|
userId
|
userId | string |
Devoluciones
- Body
- ScheduleInfo
Crear una categoría nueva
Solicitud de ejemplo:
POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
"name": "Water",
"imageName": "water.svg",
"color": "#0000cc",
"keywordMatching": "Any",
"keywords": [
{
"value": "H2O"
},
{
"value": "Water"
}
]
}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenece la categoría |
|
enabled
|
enabled | boolean | ||
|
id
|
id | string | ||
|
nombre
|
name | string | ||
|
type
|
type | True | integer |
|
|
value
|
value | string | ||
|
color
|
color | True | string | |
|
id
|
id | string | ||
|
nombre
|
name | string | ||
|
type
|
type | True | integer |
|
|
value
|
value | string | ||
|
id
|
id | string | ||
|
imageName
|
imageName | True | string | |
|
isDefault
|
isDefault | boolean | ||
|
keywordMatching
|
keywordMatching | True | integer |
|
|
palabras clave
|
keywords | True | array of string | |
|
palabras claveExcluded
|
keywordsExcluded | array of string | ||
|
nombre
|
name | True | string | |
|
options
|
options | integer |
|
|
|
order
|
order | integer | ||
|
teamId
|
teamId | string |
Devoluciones
- Body
- CategoryInfo
Crear una nueva acción remota
Solicitud de ejemplo:
POST /remoteActions
{
"teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
"name": "MyAction",
"enabled": true,
}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Language
|
language | integer |
|
|
|
nombre
|
name | True | string | |
|
value
|
value | string | ||
|
canEdit
|
canEdit | boolean | ||
|
canExecute
|
canExecute | boolean | ||
|
teamId
|
teamId | string | ||
|
definitionId
|
definitionId | string | ||
|
descripción
|
description | string | ||
|
enabled
|
enabled | boolean | ||
|
nombre
|
name | string | ||
|
teamId
|
teamId | string |
Devoluciones
Descargar informe de derechos con un fileName específico
Descargue el informe de derechos con un fileName específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. del equipo para el que desea descargar el informe de deber. |
|
Nombre de archivo
|
fileName | True | string |
Nombre de archivo del archivo csv que se va a descargar. |
Devoluciones
- response
- binary
Deshabilita una instancia de script determinada.
Deshabilita una instancia de script determinada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de instancia de script
|
instanceId | True | string |
Identificador de la instancia que se va a deshabilitar. |
Devoluciones
Deshacer cola de varias confirmaciones
Este método intenta deshacer la confirmación de varias alertas a través de una cola. La operación se controla en segundo plano.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Deshacer el cierre de una alerta
Este método intenta deshacer un cierre de alerta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador de alerta. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Devoluciones
- Body
- V2.AlertInfo
Deshacer la confirmación de una alerta
Este método intenta deshacer una confirmación de alerta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador de alerta. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Devoluciones
- Body
- V2.AlertInfo
Devuelve acciones remotas
Solicitud de ejemplo:
GET /RemoteActions?externalId=12345
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | string |
Id. de equipo |
|
|
External ID
|
externalId | string |
Filtro opcional para el identificador externo |
|
|
Tipo
|
type | integer |
|
|
|
Servicio Executor
|
executorService | string |
Servicio Executor |
|
|
Language
|
language | integer |
|
Devoluciones
- response
- array of V2.RemoteActionInfo
Devuelve el informe de alertas.
Devuelve el informe de alertas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. del equipo para el que desea obtener la información del archivo de informe de derechos. |
|
Nombre de archivo
|
fileName | True | string |
Nombre de archivo que desea descargar. |
Devoluciones
- response
- binary
Devuelve información de la programación de deberes con el identificador especificado.
Devuelve información de la programación de deberes con el identificador especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. del equipo al que pertenece el deber |
|
Id. de la programación de deberes
|
scheduleId | True | string |
Id. de la programación de deber solicitada. |
Devoluciones
- Body
- ScheduleInfo
Devuelve información sobre todas las programaciones planeadas.
Devuelve información sobre todas las programaciones planeadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer | ||
|
minDate
|
minDate | date-time | ||
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | string |
Devoluciones
- response
- array of V2.ScheduleDetails
Devuelve la información de precios del canal de la suscripción.
Devuelve la información de precios del canal de la suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción que debe recuperarse. |
Devoluciones
- Body
- ChannelPriceInfo
Devuelve las características de una suscripción especificada.
Devuelve las características de una suscripción especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción desde la que se deben recuperar las características. |
Devoluciones
- response
- array of SubscriptionFeature
Devuelve toda la información sobre una instancia de script determinada.
Obtiene la instancia de script especificada por el identificador de instancia pasado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de instancia de script
|
instanceId | True | string |
Identificador de instancia de la instancia de script que se va a devolver. |
Devoluciones
Devuelve todas las instancias de script del equipo SIGNL4.
Devuelve todas las instancias de script de la suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de equipo
|
teamId | array |
Identificadores de equipo. |
|
|
Modificado desde
|
modifiedSince | date-time |
Modificado desde. |
Devoluciones
- response
- array of ScriptInstanceInfo
Devuelve todos los scripts de inventario disponibles.
Devuelve todos los scripts de inventario disponibles que se pueden agregar a una suscripción SIGNL4.
Devoluciones
- response
- array of InventoryScriptInfo
Devuelve todos los scripts de inventario.
Devuelve todos los scripts de inventario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Language
|
language | string |
Language |
Devoluciones
- response
- array of InventoryScriptInfo
Devuelve trabajos remotos paginados desde diario
Solicitud de ejemplo:
POST /remoteActions/journal/paged?maxResults=100
{
"statusCode": "Executed"
}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número máximo de resultados
|
maxResults | integer |
Número máximo de resultados |
|
|
Language
|
language | integer |
|
|
|
actionId
|
actionId | string | ||
|
continuationToken
|
continuationToken | string | ||
|
maxCreationDate
|
maxCreationDate | date-time | ||
|
minCreationDate
|
minCreationDate | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
statusCodes
|
statusCodes | integer |
|
Devoluciones
Devuelve un script de inventario por su identificador
Obtiene el script especificado por el identificador de script pasado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de script
|
scriptId | True | string |
Identificador del script que se va a devolver. |
|
Language
|
language | string |
Language |
Devoluciones
Devuelve un trabajo remoto del diario
Solicitud de ejemplo:
GET /remoteActions/journal/{jobId}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del trabajo
|
jobId | True | string |
Identificador del trabajo que se va a devolver |
|
Language
|
language | integer |
|
Devoluciones
- Body
- V2.RemoteJob
Devuelve una acción remota
Solicitud de ejemplo:
GET /RemoteActions/{actionId}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de la acción
|
actionId | True | string |
Identificador de la acción que se va a devolver |
|
Language
|
language | integer |
|
Devoluciones
Elimina la cuenta de usuario.
Elimina la cuenta de usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario que se va a eliminar. |
Elimina la imagen actual del equipo.
Elimina la imagen actual del equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del que desea eliminar la imagen del equipo. |
Elimina una acción remota
Solicitud de ejemplo:
DELETE /eaRemoteActions/{actionId}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de la acción
|
actionId | True | string |
Identificador de la acción que se va a eliminar |
Elimina una instancia de script.
Obtiene la instancia de script especificada por el identificador de instancia pasado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de instancia de script
|
instanceId | True | string |
Identificador de instancia de la instancia de script que se va a devolver. |
Eliminación de programaciones de deberes en el intervalo
Elimina las programaciones de deber en el intervalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo que desea eliminar |
|
desde
|
from | date-time | ||
|
to
|
to | date-time |
Devoluciones
- response
- array of ScheduleInfo
Eliminación de un origen de eventos
Elimine un origen de eventos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de origen del evento
|
eventSourceId | True | string |
Identificador del origen del evento |
Eliminación de un patrón de alerta específico
Elimine un patrón de alerta específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo al que desea acceder |
|
Id. de patrón
|
patternId | True | string |
Id. de patrón para el patrón al que desea acceder |
Eliminación de una distribución de eventos
Eliminar una distribución de eventos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de origen del evento
|
distributionId | True | string |
Identificador del origen del evento |
Eliminación de una plantilla de llamada existente de la suscripción
Elimine la plantilla de llamada existente de la suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de plantilla
|
templateId | True | string |
Identificador de plantilla. |
Eliminar días festivos
Eliminar días festivos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del que desea eliminar los días festivos |
|
Día
|
day | integer | ||
|
month
|
month | integer |
|
|
|
año
|
year | integer |
Eliminar el número de teléfono de un usuario
Elimine el número de teléfono de un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario |
Eliminar imagen de usuario personal
Eliminar imagen de usuario personal.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id. de usuario o yo |
Eliminar un deber específico
Elimine un deber específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. del equipo al que pertenece el deber. |
|
Id. de la programación de deberes
|
dutyId | True | string |
Id. del deber que se va a eliminar. |
Eliminar una categoría existente
Solicitud de ejemplo:
DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenece la categoría |
|
Id. de categoría
|
categoryId | True | string |
Identificador de la categoría que se va a eliminar |
Eliminar una dirección de contacto de un usuario
Elimina una dirección de contacto de un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador de usuario del usuario del que se va a eliminar la dirección |
|
Identificador de dirección
|
addressId | True | string |
Id. de dirección de contacto |
Eliminar webhook por identificador
Elimina el webhook especificado para que ya no se le notifique.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de webhook saliente
|
webhookId | True | string |
Identificador del webhook saliente que se eliminará. |
Envía de nuevo un correo electrónico de invitación si existe una invitación.
Envía de nuevo un correo electrónico de invitación si existe una invitación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo con un usuario invitado. |
|
inviterId
|
inviterId | string | ||
|
userMail
|
userMail | True | string |
Devoluciones
- response
- string
Envía un correo a un usuario especificado.
Envía un correo a un usuario especificado que contiene información de todos los orígenes de eventos del equipo del usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador de usuario. |
|
Id. de equipo
|
teamId | string |
Identificador de equipo desde el que el usuario debe obtener la información del punto de conexión. |
Escalado manual de una alerta a un equipo
Escale manualmente una alerta a un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Id. de alerta para Alerta que desea escalar. |
|
targetTeamId
|
targetTeamId | string | ||
|
userId
|
userId | string |
Devoluciones
- response
- string
Establece la configuración de alerta de un equipo específico
Establece la configuración de alerta de un equipo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. del equipo para el que se debe establecer la configuración. |
|
escEnabled
|
escEnabled | boolean | ||
|
escMode
|
escMode | integer |
|
|
|
escRefId
|
escRefId | string | ||
|
filterAction
|
filterAction | integer |
|
|
|
filterMode
|
filterMode | integer |
|
|
|
Canal
|
channel | integer |
|
|
|
delay
|
delay | integer | ||
|
enabled
|
enabled | boolean | ||
|
optOut
|
optOut | integer |
|
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
persNotInterval
|
persNotInterval | integer | ||
|
persNotMode
|
persNotMode | integer |
|
|
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer |
Devoluciones
- Body
- AlertSettings
Establecer el número de teléfono de un usuario
Establezca el número de teléfono de un usuario. Si se guarda otro número de teléfono, se sobrescribirá.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador de usuario del usuario al que desea agregar un número de teléfono |
|
countryCode
|
countryCode | string | ||
|
número de teléfono
|
phoneNumber | string | ||
|
sendValidationCode
|
sendValidationCode | boolean | ||
|
sendValidationCodeVia
|
sendValidationCodeVia | integer |
|
Devoluciones
Establecimiento de la ubicación de un usuario
Establecer la ubicación de un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario. |
|
latitude
|
latitude | double | ||
|
longitude
|
longitude | double | ||
|
marca de tiempo
|
timestamp | date-time |
Devoluciones
- Body
- LocationInfo
Establecimiento de perfiles de notificación para el usuario
Establecer perfiles de notificación para el usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario del que desea obtener los perfiles de notificación. |
|
Canal
|
channel | integer |
|
|
|
delayInMinutes
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
options
|
options | integer | ||
|
persistente
|
persistent | boolean |
Devoluciones
Establecimiento de suscripciones de categoría
Solicitud de ejemplo:
POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenece la categoría |
|
Id. de categoría
|
categoryId | True | string |
Categoría que se va a actualizar |
|
estado
|
status | True | integer |
|
|
userId
|
userId | True | string |
Devoluciones
- response
- array of CategorySubscriptionInfo
Evento Send
Evento de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Secreto del equipo
|
teamSecret | True | string |
Secreto del equipo. |
|
Title
|
Title | True | string | |
|
Message
|
Message | True | string | |
|
X-S4-Service
|
X-S4-Service | string |
X-S4-Service: : asigna la signl a la categoría de servicio o sistema con el nombre especificado. |
|
|
X-S4-Location
|
X-S4-Location | string |
X-S4-Location: transmite información de ubicación (latitud, longitud) con el evento y muestra un mapa en la aplicación móvil. |
|
|
X-S4-AlertingScenario
|
X-S4-AlertingScenario | string |
X-S4-AlertingScenario: si este evento desencadena un signl, permite controlar cómo SIGNL4 notifica al equipo. Los valores admitidos son: single_ack, multi_ack, emergencia. |
|
|
X-S4-ExternalID
|
X-S4-ExternalID | string |
X-S4-ExternalID: si el evento se origina en un registro de un sistema de terceros, use este parámetro para pasar el identificador único de ese registro. Ese identificador se comunicará en las notificaciones de webhook de salida de SIGNL4, que es excelente para la correlación o sincronización de ese registro con Signl. |
|
|
X-S4-Status
|
X-S4-Status | string |
X-S4-Status: si desea resolver un signl existente mediante un identificador externo (X-S4-ExternalID), puede agregar este parámetro de estado. Tiene tres valores posibles: nuevos, confirmados y resueltos. |
|
|
X-S4-Filtering
|
X-S4-Filtering | boolean |
Filtrado X-S4: especifique un valor booleano de true o false para aplicar el filtrado de eventos para este evento o no. Si se establece en true, el evento solo desencadenará una notificación al equipo, si contiene al menos una palabra clave de uno de los servicios y categorías del sistema (es decir, está en la lista blanca). |
|
|
Parámetro de identificador externo
|
ExtIdParam | string |
Parámetro de identificador externo. |
|
|
Parámetro de estado externo
|
ExtStatusParam | string |
Parámetro de estado externo. |
|
|
Nuevo estado
|
NewStatus | string |
Nuevo estado. |
|
|
Parámetro de estado resuelto
|
ResolvedStatus | string |
Parámetro de estado resuelto. |
|
|
Estado de confirmación
|
AckStatus | string |
Estado de confirmación. |
Devoluciones
- Body
- OverviewEvent
Guardar días festivos para un equipo
Guardar vacaciones para un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo para el que quiere guardar las vacaciones |
|
Año
|
year | True | integer |
Año en el que quieres ahorrar días festivos |
|
Día
|
day | integer | ||
|
month
|
month | integer |
|
Devoluciones
Guardar días festivos repetidos para un equipo
Guarde los días festivos repetidos para un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo para el que quiere guardar las vacaciones |
|
Día
|
day | integer | ||
|
month
|
month | integer |
|
Devoluciones
Guardar varias programaciones
Guarde varias programaciones. Si lo desea, es posible invalidar las programaciones existentes.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. de equipo que se va a establecer |
|
Override
|
overrideExisting | boolean |
Invalide o corte las programaciones existentes si se establece en true. |
|
|
end
|
end | date-time | ||
|
id
|
id | string | ||
|
options
|
options | integer | ||
|
start
|
start | date-time | ||
|
userId
|
userId | string |
Devoluciones
- response
- array of ScheduleInfo
Habilita una instancia de script
Habilita una instancia de script.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de instancia de script
|
instanceId | True | string |
Identificador de la instancia que se va a habilitar. |
Devoluciones
Invitar a usuarios a un equipo
Invite a los usuarios a un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
inviterId
|
inviterId | string | ||
|
Correo electrónico
|
string | |||
|
roleId
|
roleId | string | ||
|
teamId
|
teamId | True | string |
Devoluciones
- response
- array of V2.InvitationResult
Obtención de entradas de escala de tiempo de alerta
Obtiene las entradas de la escala de tiempo de alerta de una alerta por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador de la alerta solicitada. |
|
Id. de usuario
|
userId | string |
Id. de usuario |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of |
Obtención de la configuración de deberes de equipo para varios equipos
Obtenga la configuración de deberes de equipo para varios equipos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de equipo
|
teamId | array |
Identificadores de equipo. |
Devoluciones
Obtención de la configuración de prepago actual de la suscripción
Obtención de métricas para todas las categorías
Solicitud de ejemplo:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenecen las categorías |
Devoluciones
- response
- array of CategoryMetrics
Obtención de métricas para una categoría específica
Solicitud de ejemplo:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenece la categoría |
|
Id. de categoría
|
categoryId | True | string |
Identificador de la categoría que se va a obtener |
Devoluciones
- Body
- CategoryMetrics
Obtención de notificaciones de alertas
Obtenga notificaciones de todos los usuarios por identificador de alerta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador de la alerta solicitada. |
Devoluciones
- response
- array of AlertNotificationInfo
Obtención de orígenes de eventos de uno o varios equipos
Obtenga orígenes de eventos de uno o varios equipos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de equipo
|
teamId | array |
Identificadores de equipo para obtener los orígenes de eventos. Si no agrega ningún identificador de equipo, obtendrá orígenes de eventos a los que tiene acceso desde la suscripción. |
|
|
Incluir interno
|
includeInternal | boolean |
Si el tipo de orígenes de eventos interno true (Sistema, Manual, API) se incluirá en el resultado. |
|
|
Language
|
language | integer |
|
Devoluciones
Obtención de parámetros de evento
Obtiene los parámetros de un evento por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del evento
|
eventId | True | string |
Identificador de evento de la alerta solicitada. |
Devoluciones
- response
- array of EventParameterInfo
Obtención de perfiles de notificación para el usuario
Obtener perfiles de notificación para el usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario del que desea obtener los perfiles de notificación. |
Devoluciones
Obtención de pertenencias a equipos de un usuario
Obtener pertenencias a equipos de un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador de usuario al que desea acceder. |
Devoluciones
- response
- array of V2.TeamMembershipDetails
Obtención de pertenencias a equipos por equipo
Obtener pertenencias a equipos por equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo al que desea acceder. |
Devoluciones
- response
- array of V2.TeamMembershipDetails
Obtención de todos los patrones de alertas del equipo
Obtenga todos los patrones de alerta del equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo al que desea acceder |
Devoluciones
- response
- array of V2.AlertingPatternDetails
Obtención de todos los usuarios de equipos especificados
Obtener todos los usuarios de los equipos especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de equipo
|
teamId | array |
Identificadores de equipo que se van a solicitar. Si está vacío, obtendrá todos los usuarios de todos los equipos a los que tiene acceso. |
Devoluciones
Obtención de una imagen de usuario personal
Obtenga una imagen de usuario personal.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id. de usuario". |
|
Alto de la imagen
|
height | integer |
Alto de la imagen". |
|
|
Ancho de imagen
|
width | integer |
Ancho de la imagen." |
Devoluciones
- Body
- UserImage
Obtención del estado del deber por identificador de usuario
Devuelve un objeto con información de deber.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario que se va a obtener. Use "Me" para obtener información sobre el usuario que ha iniciado sesión actualmente. Esto no es posible con una clave de API. También puede ser una dirección de correo electrónico de un usuario en el equipo o el identificador único de un objeto de usuario según el usuario". |
|
Id. de equipo
|
teamId | array |
Id. de equipo". |
Devoluciones
Obtención del evento de información general paginado
Obtener información general sobre eventos paginados. Si hay más resultados, también obtendrá un token de continuación que puede agregar al filtro de eventos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
maxResults | integer |
Define el límite de detalles de alerta recuperados por solicitud. Se permiten de 1 a 100 por solicitud. El número de alertas podría ser menor si se filtra, pero al menos 1. |
|
|
nextPartitionKey
|
nextPartitionKey | string | ||
|
nextRowKey
|
nextRowKey | string | ||
|
nextTableName
|
nextTableName | string | ||
|
eventSourceId
|
eventSourceId | string | ||
|
eventStatusCode
|
eventStatusCode | integer |
|
|
|
maxCreationDate
|
maxCreationDate | date-time | ||
|
minCreationDate
|
minCreationDate | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
teamid
|
teamid | string | ||
|
textToSearch
|
textToSearch | string |
Devoluciones
Obtención del origen del evento por identificador
Obtenga el origen del evento por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de origen del evento
|
eventSourceId | True | string |
Identificador del origen del evento. |
|
Language
|
language | integer |
|
Devoluciones
Obtención del saldo de prepago actual de la suscripción
Obtener detalles de un evento
Obtenga detalles de un evento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del evento
|
eventId | True | string |
Identificador de evento para el evento que desea obtener |
Devoluciones
- Body
- V2.EventDetails
Obtener detalles sobre una alerta
Obtenga detalles sobre una alerta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Alerta que quiere obtener. |
|
Id. de usuario
|
userId | string |
Identificador de usuario del usuario en el que se llama a la API. Se usa con fines de filtrado con respecto a la alerta. |
Devoluciones
- Body
- V2.AlertDetails
Obtener días festivos para el equipo
Obtener días festivos para el equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Id. de equipo del que quieres obtener días festivos |
Devoluciones
Obtener el saldo prepago actual de una suscripción
Obtenga el saldo de prepago actual de una suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción |
Devoluciones
- Body
- PrepaidBalanceInfo
Obtener información de datos adjuntos de una alerta
Obtener datos adjuntos de una alerta por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador de la alerta solicitada. |
Devoluciones
- response
- array of V2.AlertAttachmentInfo
Obtener información de todas las suscripciones disponibles y administradas
Obtenga información de todas las suscripciones disponibles o administradas.
Devoluciones
- response
- array of SubscriptionInfo
Obtener información de todos los equipos
Obtenga información de todos los equipos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de equipo
|
teamId | array |
Identificadores de equipo |
Devoluciones
- response
- array of TeamInfo
Obtener información de una suscripción específica
Obtiene información de una suscripción específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción que se va a recuperar. |
Devoluciones
- Body
- SubscriptionInfo
Obtener información del asistente de servicio para equipos
Obtenga información del asistente de servicio para los equipos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de equipo
|
teamId | array |
Identificadores de los equipos para los que obtener los resúmenes. |
|
|
Últimas dos tareas
|
lastTwoDuties | boolean |
Decida si desea todas las tareas o solo las dos últimas. |
Devoluciones
Obtener información general del evento
Obtenga información general del evento por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del evento
|
eventId | True | string |
Identificador del evento que se va a obtener. |
Devoluciones
- Body
- OverviewEvent
Obtener información para todos los equipos de la suscripción
Obtenga información para todos los equipos de la suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción que se va a actualizar |
Devoluciones
- response
- array of TeamInfo
Obtener información pública sobre todos los equipos de una suscripción
Obtenga información pública sobre todos los equipos de una suscripción.
Devoluciones
- response
- array of V2.TeamPublicDetails
Obtener información sobre los informes de alertas descargables
Obtenga información sobre los informes de alertas descargables.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo desde el que desea descargar informes. |
Devoluciones
- response
- array of AlertAuditReportFileInfo
Obtener informe de alertas
Devuelve información sobre el volumen de alertas ocurrido en diferentes períodos de tiempo, así como información sobre el comportamiento de respuesta (cantidad de alertas confirmadas y no controladas) de los miembros del equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | string |
Identificador de usuario del usuario para el que desea un informe. |
|
|
Identificadores de equipo
|
teamId | array |
Identificadores de equipo de los equipos para los que desea obtener un informe. Si no establece un identificador de equipo, obtendrá todos los recursos de todos los equipos a los que tiene acceso. |
Devoluciones
Obtener la configuración de prepago actual de una suscripción
Obtenga la configuración de prepago actual de una suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción |
Devoluciones
- Body
- PrepaidSettingsInfo
Obtener la configuración de privacidad del equipo para un equipo
Obtiene la configuración de privacidad del equipo para un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del equipo |
Devoluciones
Obtener las transacciones de prepago de la suscripción
Obtenga las transacciones de prepago de la suscripción.
Devoluciones
- response
- array of PrepaidTransactionInfo
Obtener las transacciones de prepago de una suscripción
Obtiene las transacciones de prepago de una suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción para la que se van a obtener transacciones |
Devoluciones
- response
- array of PrepaidTransactionInfo
Obtener suscripciones de categoría
Solicitud de ejemplo:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenece la categoría |
|
Id. de categoría
|
categoryId | True | string |
Categoría para obtener suscripciones para |
Devoluciones
- response
- array of CategorySubscriptionInfo
Obtener todas las categorías
Obtiene todas las categorías.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | array |
Id. de equipo. |
Devoluciones
Obtener todas las categorías
Solicitud de ejemplo:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenecen las categorías |
Devoluciones
- response
- array of CategoryInfo
Obtener todas las plantillas de llamada de la suscripción
Obtenga todas las plantillas de llamada de la suscripción.
Devoluciones
- response
- array of V2.CalloutTemplateDetails
Obtener todos los equipos de los que es miembro el usuario
Devuelve una lista de objetos de equipo con detalles como su nombre. Solo se devolverán los equipos de los que sea miembro el usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
userId | True | string |
Id. de equipo. |
Devoluciones
- response
- array of TeamInfo
Obtener todos los usuarios
Devuelve una lista de objetos de usuario con detalles como su dirección de correo electrónico e información de servicio. Solo se devolverán los usuarios a los que tenga acceso.
Devoluciones
- response
- array of V2.UserDetails
Obtener una alerta
Obtiene una alerta por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador de la alerta solicitada. |
|
Id. de usuario
|
userId | string |
Id. de usuario |
Devoluciones
- Body
- V2.AlertInfo
Obtener una categoría específica
Solicitud de ejemplo:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo al que pertenece la categoría |
|
Id. de categoría
|
categoryId | True | string |
Identificador de la categoría que se va a obtener |
Devoluciones
- Body
- CategoryInfo
Obtener usuario por identificador
Devuelve un objeto de usuario con detalles como su dirección de correo electrónico e información de deber.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario que se va a obtener. Use "Me" para obtener información sobre el usuario que ha iniciado sesión actualmente. Esto no es posible con una clave de API. También puede ser una dirección de correo electrónico de un usuario en el equipo o el identificador único de un objeto de usuario según el usuario". |
Devoluciones
- Body
- V2.UserDetails
Obtener webhook por identificador
Devuelve información del webhook especificado por el identificador pasado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de webhook saliente
|
webhookId | True | string |
Identificador del webhook de salida que se va a recuperar. |
Devoluciones
- Body
- WebhookInfo
Obtener webhooks
Devuelve una colección de webhooks salientes definidos en el sistema.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | string |
Id. de equipo. |
Devoluciones
- response
- array of WebhookInfo
Obtiene alertas paginadas.
Obtiene alertas paginadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | string |
Identificador de usuario del usuario para el que desea obtener alertas. |
|
|
Límite de alertas
|
maxResults | integer |
Define el límite de detalles de alerta recuperados por solicitud. Se permiten de 1 a 100 por solicitud. El número de alertas podría ser menor si se filtra, pero al menos 1. |
|
|
afterId
|
afterId | string | ||
|
alertIds
|
alertIds | array of string | ||
|
alertStatusCodes
|
alertStatusCodes | integer |
|
|
|
categoryIds
|
categoryIds | array of string | ||
|
nextPartitionKey
|
nextPartitionKey | string | ||
|
nextRowKey
|
nextRowKey | string | ||
|
nextTableName
|
nextTableName | string | ||
|
ID externo
|
externalId | string | ||
|
maxCreated
|
maxCreated | date-time | ||
|
minCreated
|
minCreated | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
showPersonalHiddenCategories
|
showPersonalHiddenCategories | boolean | ||
|
teamIds
|
teamIds | array of string | ||
|
textToSearch
|
textToSearch | string |
Devoluciones
Obtiene el progreso de la configuración de un equipo específico.
Obtiene el progreso de la configuración de un equipo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo para el que se debe recuperar el progreso. |
Devoluciones
- Body
- TeamSetupProgress
Obtiene el progreso de la configuración de un usuario específico.
Obtiene el progreso de la configuración de un usuario específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador del usuario para el que se debe recuperar el progreso. |
Devoluciones
- Body
- UserSetupProgress
Obtiene información de un equipo específico.
Obtiene información de un equipo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo que se debe recuperar. |
Devoluciones
- Body
- TeamInfo
Obtiene la configuración de alerta de un equipo específico.
Obtiene la configuración de alerta de un equipo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | array |
ID del equipo. |
Devoluciones
Obtiene la configuración de alerta de un equipo específico.
Obtiene la configuración de alerta de un equipo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo para el que se debe recuperar la configuración. |
Devoluciones
- Body
- AlertSettings
Obtiene la imagen de un equipo especificado.
Obtiene la imagen de un equipo especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo del que desea obtener la imagen. |
|
Alto de la imagen
|
height | integer |
Parámetro opcional que define el alto deseado de la imagen que se recupera. |
|
|
Ancho de imagen
|
width | integer |
Parámetro opcional que define el ancho deseado de la imagen que se recupera. |
Devoluciones
- Body
- V2.TeamImageDetails
Obtiene las licencias de número de voz de una suscripción.
Obtiene las licencias de número de voz de una suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción |
Devoluciones
- Body
- UserLicenseInfo
Obtiene las licencias de usuario de una suscripción.
Obtiene las licencias de usuario de una suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de suscripción
|
subscriptionId | True | string |
Identificador de la suscripción |
Devoluciones
- Body
- UserLicenseInfo
Obtiene los nombres de todas las imágenes de categoría de alerta.
Obtiene los nombres de todas las imágenes de categoría de alerta. Para obtener la imagen, vaya a account.signl4.com/images/alerts/categoryImageName.svg.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obtiene orígenes de eventos de un equipo específico.
Obtiene orígenes de eventos de un equipo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo para el que deben recuperarse los orígenes. |
Devoluciones
- response
- array of EventSourceEndpointInfo
Obtiene un archivo adjunto especificado de una alerta especificada.
Obtiene un archivo adjunto especificado de una alerta especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de alerta
|
alertId | True | string |
Identificador de la alerta que contiene los datos adjuntos deseados. |
|
Id. de datos adjuntos
|
attachmentId | True | string |
Identificador de los datos adjuntos que desea recuperar. |
|
Ancho de imagen
|
width | integer |
Parámetro opcional que define el ancho deseado de la imagen que se recupera. |
|
|
Alto de la imagen
|
height | integer |
Parámetro opcional que define el alto deseado de la imagen que se recupera. |
|
|
Scale
|
scale | boolean |
Parámetro opcional que define si se quiere escalar la imagen recuperada. El valor predeterminado se establece en true. |
Devoluciones
- response
- binary
Puntee al usuario
El usuario especificado se perforará del deber.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Devoluciones
Puntee al usuario como administrador
El usuario especificado se perforará como administrador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Devoluciones
Puntee al usuario en
El usuario especificado se perforará en el deber.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Devoluciones
Quita un usuario o una invitación de un equipo
Quita un usuario o una invitación de un equipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador del equipo del que se debe eliminar el usuario |
|
Id. de usuario
|
userId | True | string |
Identificador del usuario que se debe eliminar |
|
Id. de usuario
|
requesterUserId | string |
Identificador de usuario del usuario que quitará el otro usuario. |
Recuperación de una definición
Recuperar una definición.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de definición
|
definitionId | True | string |
Identificador de definición |
|
Language
|
language | integer |
|
Devoluciones
Recuperar toda la definición disponible
Recupere toda la definición disponible.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Language
|
language | integer |
|
Devoluciones
Retirar el cierre de varias alertas
Este método intenta deshacer varios cierres de alerta. La operación se controla en segundo plano.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Valida un número de teléfono creado anteriormente para un usuario
Valida un número de teléfono creado anteriormente para un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador de usuario del usuario que desea validar el número de teléfono creado anteriormente |
|
número de teléfono
|
phoneNumber | string | ||
|
validationCode
|
validationCode | string |
Validación de intervalos de tiempo de un patrón
Valide una ranura de tiempo de un patrón en todos los intervalos de tiempo existentes de otros patrones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de equipo
|
teamId | True | string |
Identificador de equipo del patrón de alertas |
|
Id. de patrón
|
patternId | string |
Id. de patrón de alerta del patrón para el que desea ahorrar espacios de tiempo. Puede ser NULL |
|
|
Identificadores de categoría
|
categoryIds | array |
Identificadores de categoría del patrón que desea validar. Puede ser NULL. |
|
|
hora
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
día laborable
|
weekday | integer |
|
|
|
id
|
id | string |
Devoluciones
Definiciones
AlertAuditReportFileInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileSizeInBytes
|
fileSizeInBytes | integer | |
|
lastRecord
|
lastRecord | date-time | |
|
lastActualizado
|
lastUpdated | date-time | |
|
month
|
month | integer | |
|
año
|
year | integer |
AlertEscalationModes
AlertFilterActions
AlertFilterModes
AlertNotificationInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
address
|
address | string | |
|
deviceName
|
deviceName | string | |
|
lastUpdate
|
lastUpdate | date-time | |
|
messageStatus
|
messageStatus | AlertNotificationInfoMessageStatus |
|
|
messageStatusErrorCode
|
messageStatusErrorCode | integer | |
|
notificationChannelType
|
notificationChannelType | AlertNotificationInfoChannelType |
|
|
userId
|
userId | string | |
|
userStatus
|
userStatus | AlertNotificationInfoUserStatus |
|
AlertNotificationInfoChannelType
- 0 = Ninguno
- 1 = Insertar
- 2 = Correo electrónico
- 4 = Bot
- 8 = Voz
- 16 = SMS
- 0 = Ninguno
- 1 = Insertar
- 2 = Correo electrónico
- 4 = Bot
- 8 = Voz
- 16 = SMS
AlertNotificationInfoMessageStatus
- 0 = Ninguno
- 1 = Rechazado
- 2 = Error
- 3 = En cola
- 4 = Transmitido
- 5 = Almacenado en búfer
- 6 = Entregado
- 7 = Cancelado
- 8 = Protegido
- 9 = AbusoProtected
- 10 = Retrasado
- 0 = Ninguno
- 1 = Rechazado
- 2 = Error
- 3 = En cola
- 4 = Transmitido
- 5 = Almacenado en búfer
- 6 = Entregado
- 7 = Cancelado
- 8 = Protegido
- 9 = AbusoProtected
- 10 = Retrasado
AlertNotificationInfoUserStatus
- 0 = Ninguno
- 1 = MessageCreated
- 2 = NotOnDuty
- 3 = CategoryHidden
- 4 = CategoryMuted
- 5 = NoNotificationProfiles
- 6 = NoMessagesByNotificationProfiles
- 0 = Ninguno
- 1 = MessageCreated
- 2 = NotOnDuty
- 3 = CategoryHidden
- 4 = CategoryMuted
- 5 = NoNotificationProfiles
- 6 = NoMessagesByNotificationProfiles
AlertResponseModes
AlertSettings
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
escEnabled
|
escEnabled | boolean | |
|
escMode
|
escMode | AlertEscalationModes |
|
|
escRefId
|
escRefId | string | |
|
filterAction
|
filterAction | AlertFilterActions |
|
|
filterMode
|
filterMode | AlertFilterModes |
|
|
notificationProfileOverrides
|
notificationProfileOverrides | array of AlertSettingsNotificationProfile | |
|
optOut
|
optOut | TeamCategoryOptOutModes |
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
persNotInterval
|
persNotInterval | integer | |
|
persNotMode
|
persNotMode | PersistentNotificationModes |
|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer |
AlertSettingsChannelType
AlertSettingsNotificationProfile
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Canal
|
channel | AlertSettingsChannelType |
|
|
delay
|
delay | integer | |
|
enabled
|
enabled | boolean |
CategoryAugmentation
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
id
|
id | string | |
|
nombre
|
name | string | |
|
type
|
type | CategoryAugmentationType |
|
|
value
|
value | string |
CategoryAugmentationType
CategoryEnrichment
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nombre
|
name | string | |
|
type
|
type | CategoryEnrichmentType |
|
|
value
|
value | string |
CategoryEnrichmentType
CategoryInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
augmentations
|
augmentations | array of CategoryAugmentation | |
|
color
|
color | string | |
|
Enriquecimientos
|
enrichments | array of CategoryEnrichment | |
|
id
|
id | string | |
|
imageName
|
imageName | string | |
|
isDefault
|
isDefault | boolean | |
|
keywordMatching
|
keywordMatching | KeywordMatchingType |
|
|
palabras clave
|
keywords | array of string | |
|
palabras claveExcluded
|
keywordsExcluded | array of string | |
|
nombre
|
name | string | |
|
options
|
options | CategoryInfoOptions |
|
|
order
|
order | integer | |
|
teamId
|
teamId | string |
CategoryInfoOptions
- 0 = Ninguno
- 1 = Oculto
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
- 0 = Ninguno
- 1 = Oculto
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
CategoryMetrics
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
last24h
|
last24h | integer | |
|
lastAlert
|
lastAlert | date-time | |
|
subscriberCount
|
subscriberCount | integer |
CategorySubscriptionInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estado
|
status | CategorySubscriptionStatus |
|
|
userId
|
userId | string |
CategorySubscriptionStatus
ChannelPriceInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
mensaje de texto
|
sms | integer | |
|
voicePerMinute
|
voicePerMinute | integer |
DutySummaryInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
dutyEnd
|
dutyEnd | date-time | |
|
dutyId
|
dutyId | string | |
|
dutyStart
|
dutyStart | date-time |
EventParameterInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string | |
|
order
|
order | integer | |
|
type
|
type | EventParameterTypes |
|
|
value
|
value | string |
EventParameterTypes
- 0 = Ninguno
- 1 = Objeto
- 2 = Matriz
- 3 = Constructor
- 4 = Propiedad
- 5 = Comentario
- 6 = Entero
- 7 = Float
- 8 = Cadena
- 9 = Boolean
- 10 = Null
- 11 = Sin definir
- 12 = Fecha
- 13 = Sin procesar
- 14 = Bytes
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
- 0 = Ninguno
- 1 = Objeto
- 2 = Matriz
- 3 = Constructor
- 4 = Propiedad
- 5 = Comentario
- 6 = Entero
- 7 = Float
- 8 = Cadena
- 9 = Boolean
- 10 = Null
- 11 = Sin definir
- 12 = Fecha
- 13 = Sin procesar
- 14 = Bytes
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
EventSeverities
EventSourceEndpointInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
address
|
address | string | |
|
descripción
|
description | string | |
|
disabled
|
disabled | boolean | |
|
groupId
|
groupId | string | |
|
id
|
id | string | |
|
lastEvent
|
lastEvent | date-time | |
|
nombre
|
name | string | |
|
subtipo
|
subType | string | |
|
ID de suscripción
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
type
|
type | EventSourceTypes |
|
EventSourceTypes
- 0 = Ninguno
- 1 = Correo electrónico
- 2 = WebHook
- 3 = Script
- 4 = Sistema
- 5 = Manual
- 6 = Voz
- 7 = Api
- 0 = Ninguno
- 1 = Correo electrónico
- 2 = WebHook
- 3 = Script
- 4 = Sistema
- 5 = Manual
- 6 = Voz
- 7 = Api
EventStatusCodes
- 0 = Ninguno
- 1 = Procesamiento
- 2 = Signled
- 3 = Filtrado
- 4 = Resuelto
- 5 = Descartado
- 6 = Confirmado
- 7 = Suprimido
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Error
- 0 = Ninguno
- 1 = Procesamiento
- 2 = Signled
- 3 = Filtrado
- 4 = Resuelto
- 5 = Descartado
- 6 = Confirmado
- 7 = Suprimido
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Error
InventoryScriptInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
config
|
config | ||
|
datos
|
data | ScriptDescriptionData | |
|
eventPattern
|
eventPattern | ||
|
localizationDetails
|
localizationDetails | array of ScriptLocalizationDetail | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
visibilidad
|
visibility | string |
KeywordMatchingType
LocationInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
latitude
|
latitude | double | |
|
longitude
|
longitude | double | |
|
marca de tiempo
|
timestamp | date-time |
MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of EventSourceEndpointInfo | |
|
Errores
|
errors | array of V2.EventSourceEndpointError |
MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of TeamDutySummaryInfo | |
|
Errores
|
errors | array of V2.TeamDutySummaryError |
MultiTeamResult-2-UserDutyInfo-V2.DutyError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of UserDutyInfo | |
|
Errores
|
errors | array of V2.DutyError |
MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of V2.AlertCountsDetails | |
|
Errores
|
errors | array of V2.AlertReportError |
MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of V2.AlertSettingsDetails | |
|
Errores
|
errors | array of V2.AlertSettingsError |
MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of V2.CategoryDetails | |
|
Errores
|
errors | array of V2.CategoryError |
MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of V2.TeamDutySettingsDetails | |
|
Errores
|
errors | array of V2.TeamDutySettingsError |
MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of V2.TeamPermissions | |
|
Errores
|
errors | array of V2.PermissionError |
MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of V2.UserDetails | |
|
Errores
|
errors | array of V2.TeamUserError |
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
datos
|
data | array of V2.UserDutyDetails | |
|
Errores
|
errors | array of V2.DutyChangeError |
OverviewEvent
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
acknowledgedAlerts
|
acknowledgedAlerts | array of string | |
|
alertId
|
alertId | string | |
|
categoryId
|
categoryId | string | |
|
closedAlerts
|
closedAlerts | array of string | |
|
creationTime
|
creationTime | date-time | |
|
eventSourceGroupId
|
eventSourceGroupId | string | |
|
eventSourceId
|
eventSourceId | string | |
|
eventSourceTeamId
|
eventSourceTeamId | string | |
|
eventSourceType
|
eventSourceType | EventSourceTypes |
|
|
eventStatus
|
eventStatus | EventStatusCodes |
|
|
id
|
id | string | |
|
última modificación
|
lastModified | date-time | |
|
severity
|
severity | EventSeverities |
|
|
teamId
|
teamId | string | |
|
texto
|
text | string | |
|
title
|
title | string |
PagedResultsPublicContinuationToken
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nextPartitionKey
|
nextPartitionKey | string | |
|
nextRowKey
|
nextRowKey | string | |
|
nextTableName
|
nextTableName | string |
PagedResultsPublic-1-OverviewEvent-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of OverviewEvent |
PagedResultsPublic-1-V2.AlertInfo-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of V2.AlertInfo |
PagedResultsPublic-1-V2.RemoteJob-
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of V2.RemoteJob |
PersistentNotificationModes
PrepaidBalanceInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
equilibrar
|
balance | integer | |
|
latestTopUp
|
latestTopUp | date-time | |
|
pendingTransactions
|
pendingTransactions | boolean |
PrepaidSettingsInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
topUpAmount
|
topUpAmount | integer | |
|
topUpEnabled
|
topUpEnabled | boolean | |
|
topUpLimit
|
topUpLimit | integer |
PrepaidTransactionInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
importe
|
amount | integer | |
|
autoTopUpId
|
autoTopUpId | string | |
|
creado
|
created | date-time | |
|
createdBy
|
createdBy | string | |
|
divisa
|
currency | string | |
|
modified
|
modified | date-time | |
|
packageCode
|
packageCode | string | |
|
estado
|
status | string | |
|
código de estado
|
statusCode | integer | |
|
ID de suscripción
|
subscriptionId | string | |
|
transactionId
|
transactionId | string |
ScheduleInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
end
|
end | date-time | |
|
id
|
id | string | |
|
options
|
options | integer | |
|
start
|
start | date-time | |
|
userId
|
userId | string |
ScriptDescriptionData
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
descripción
|
description | string | |
|
nombre
|
name | string | |
|
scriptType
|
scriptType | string | |
|
descripción breve
|
shortDescription | string |
ScriptInstanceDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
config
|
config | ||
|
customScriptDescription
|
customScriptDescription | string | |
|
customScriptName
|
customScriptName | string | |
|
enabled
|
enabled | boolean | |
|
eventPattern
|
eventPattern | ||
|
eventSourceId
|
eventSourceId | string | |
|
instanceId
|
instanceId | string | |
|
última modificación
|
lastModified | date-time | |
|
runtimeInformation
|
runtimeInformation | ScriptInstanceInfoRuntimeInformationModel | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
ID de suscripción
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
webhookUrl
|
webhookUrl | string |
ScriptInstanceInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
customScriptDescription
|
customScriptDescription | string | |
|
customScriptName
|
customScriptName | string | |
|
enabled
|
enabled | boolean | |
|
eventPattern
|
eventPattern | ||
|
eventSourceId
|
eventSourceId | string | |
|
instanceId
|
instanceId | string | |
|
última modificación
|
lastModified | date-time | |
|
runtimeInformation
|
runtimeInformation | ScriptInstanceInfoRuntimeInformationModel | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
ID de suscripción
|
subscriptionId | string | |
|
teamId
|
teamId | string |
ScriptInstanceInfoRuntimeInformationModel
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
runtimeStatus
|
runtimeStatus | ScriptInstanceInfoRuntimeStatus |
|
|
runtimeStatusMessage
|
runtimeStatusMessage | string |
ScriptInstanceInfoRuntimeStatus
- 0 = Desconocido
- 1 = Inicio
- 2 = Ok
- 3 = Detener
- 4 = Detenido
- -1 = Error
- 0 = Desconocido
- 1 = Inicio
- 2 = Ok
- 3 = Detener
- 4 = Detenido
- -1 = Error
ScriptLocalizationDetail
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
config
|
config | ||
|
datos
|
data | ScriptDescriptionData | |
|
lenguaje
|
language | string |
SubscriptionFeature
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string | |
|
type
|
type | integer | |
|
value
|
value | string |
SubscriptionInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
branchId
|
branchId | string | |
|
country
|
country | string | |
|
divisa
|
currency | string | |
|
externalAccountId
|
externalAccountId | string | |
|
id
|
id | string | |
|
nombre
|
name | string | |
|
nextBilling
|
nextBilling | date-time | |
|
ownerId
|
ownerId | string | |
|
planCode
|
planCode | string | |
|
planState
|
planState | integer | |
|
referralEnabled
|
referralEnabled | boolean | |
|
estado
|
status | integer |
TeamCategoryOptOutModes
TeamDutySummaryInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
dutyAssistEnabled
|
dutyAssistEnabled | boolean | |
|
dutySummaries
|
dutySummaries | array of DutySummaryInfo | |
|
teamId
|
teamId | string |
TeamInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
imageLastModified
|
imageLastModified | date-time | |
|
memberIds
|
memberIds | array of string | |
|
nombre
|
name | string | |
|
setupProgressEnabled
|
setupProgressEnabled | boolean | |
|
ID de suscripción
|
subscriptionId | string | |
|
timezone
|
timezone | string |
TeamSetupProgress
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
completedSteps
|
completedSteps | array of string | |
|
teamId
|
teamId | string | |
|
marca de tiempo
|
timestamp | date-time |
UserDutyInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lastChange
|
lastChange | date-time | |
|
onDuty
|
onDuty | boolean | |
|
onManagerDuty
|
onManagerDuty | boolean | |
|
atrasado
|
overdue | boolean | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
UserImage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contenido
|
content | byte | |
|
contentDispostion
|
contentDispostion | string | |
|
contentEncoding
|
contentEncoding | string | |
|
tipo de contenido
|
contentType | string | |
|
última modificación
|
lastModified | date-time | |
|
nombre
|
name | string |
Información de usuario
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
colorIndex
|
colorIndex | integer | |
|
contactAddresses
|
contactAddresses | array of | |
|
dutyInfos
|
dutyInfos | UserDutyInfo | |
|
externalAuthProvider
|
externalAuthProvider | string | |
|
id
|
id | string | |
|
isDeactivated
|
isDeactivated | boolean | |
|
isInvite
|
isInvite | boolean | |
|
isRemoteActionPinSet
|
isRemoteActionPinSet | boolean | |
|
lastSeen
|
lastSeen | date-time | |
|
correo
|
string | ||
|
nombre
|
name | string | |
|
roleId
|
roleId | string | |
|
ID de suscripción
|
subscriptionId | string | |
|
timeZone
|
timeZone | string | |
|
userImageLastModified
|
userImageLastModified | date-time |
UserLicenseInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
currentUsers
|
currentUsers | integer | |
|
isFree
|
isFree | boolean | |
|
isTrial
|
isTrial | boolean | |
|
licensedUsers
|
licensedUsers | integer | |
|
planCode
|
planCode | string |
UserPermission
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
permitido
|
allowed | boolean | |
|
permiso
|
permission | string |
UserSetupProgress
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
completedSteps
|
completedSteps | array of string | |
|
marca de tiempo
|
timestamp | date-time | |
|
userId
|
userId | string |
V2. AlertAnnotationDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
teamId
|
teamId | string | |
|
texto
|
text | string | |
|
marca de tiempo
|
timestamp | date-time | |
|
type
|
type | V2.AlertAnnotationTypes |
|
|
userId
|
userId | string |
V2. AlertAnnotationTypes
V2. AlertAttachmentInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
tipo de contenido
|
contentType | string | |
|
id
|
id | string | |
|
nombre
|
name | string |
V2. AlertCategoryCountsDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
reconocido
|
acknowledged | integer | |
|
categoryId
|
categoryId | string | |
|
cerrado
|
closed | integer | |
|
no controlada
|
unhandled | integer |
V2. AlertCountTypes
- 1 = TeamCurrentDuty
- 2 = TeamLastDuty
- 3 = UserLastDutyChange
- 4 = Last24Hours
- 1 = TeamCurrentDuty
- 2 = TeamLastDuty
- 3 = UserLastDutyChange
- 4 = Last24Hours
V2. AlertCountsDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
reconocido
|
acknowledged | integer | |
|
categoryCounts
|
categoryCounts | array of V2.AlertCategoryCountsDetails | |
|
cerrado
|
closed | integer | |
|
end
|
end | date-time | |
|
última modificación
|
lastModified | date-time | |
|
start
|
start | date-time | |
|
ID de suscripción
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
type
|
type | V2.AlertCountTypes |
|
|
typeString
|
typeString | string | |
|
no controlada
|
unhandled | integer | |
|
userId
|
userId | string |
V2. AlertDeliveryStatusCodes
- 0 = Ninguno
- 1 = Abrir
- 2 = Error
- 4 = Transmitido
- 6 = Entregado
- 8 = Protegido
- 9 = AbusoProtected
- 22 = ParcialmenteFailed
- 24 = ParcialmenteTransmitted
- 26 = ParcialmenteDelivered
- 30 = NoOneOnDuty
- 31 = NoOneNotified
- 0 = Ninguno
- 1 = Abrir
- 2 = Error
- 4 = Transmitido
- 6 = Entregado
- 8 = Protegido
- 9 = AbusoProtected
- 22 = ParcialmenteFailed
- 24 = ParcialmenteTransmitted
- 26 = ParcialmenteDelivered
- 30 = NoOneOnDuty
- 31 = NoOneNotified
V2. AlertDeliveryStatusDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
código de estado
|
statusCode | V2.AlertDeliveryStatusCodes |
|
|
userDeliveryStatus
|
userDeliveryStatus | array of V2.UserDeliveryStatus |
V2. AlertDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.EventParameterDetails | |
|
attachments
|
attachments | array of V2.AlertAttachmentInfo | |
|
categoryId
|
categoryId | string | |
|
Escalamientos
|
escalations | array of V2.AlertEscalationDetails | |
|
eventId
|
eventId | string | |
|
ID externo
|
externalId | string | |
|
Banderas
|
flags | V2.AlertFlags |
|
|
historia
|
history | V2.AlertHistoryInfo | |
|
id
|
id | string | |
|
última modificación
|
lastModified | date-time | |
|
requiredAcknowledgements
|
requiredAcknowledgements | integer | |
|
severity
|
severity | V2.AlertSeverities |
|
|
estado
|
status | V2.AlertStatusDetails | |
|
ID de suscripción
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
texto
|
text | string | |
|
timelineEntries
|
timelineEntries | array of | |
|
title
|
title | string | |
|
workflowType
|
workflowType | V2.AlertWorkflowTypes |
|
V2. AlertEscalationDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
alertStatus
|
alertStatus | V2.AlertStatusCodes |
|
|
escType
|
escType | V2.AlertEscalationType |
|
|
estado
|
status | V2.AlertEscalationStatus |
|
|
teamId
|
teamId | string | |
|
teamName
|
teamName | string | |
|
marca de tiempo
|
timestamp | date-time |
V2. AlertEscalationStatus
- 0 = Ok
- 1 = InProgress
- 2 = TargetInvalid
- 3 = TargetPrivate
- 4 = Filtrado
- 5 = Suprimido
- 0 = Ok
- 1 = InProgress
- 2 = TargetInvalid
- 3 = TargetPrivate
- 4 = Filtrado
- 5 = Suprimido
V2. AlertEscalationType
V2. AlertFlags
- 0 = Ninguno
- 1 = HasAttachments
- 2 = HasAnnotations
- 4 = IsBreached
- 8 = HasLocationInfo
- 16 = EscalatedToTeam
- 32 = EscalatedToManager
- 64 = CreatedByEscalation
- 0 = Ninguno
- 1 = HasAttachments
- 2 = HasAnnotations
- 4 = IsBreached
- 8 = HasLocationInfo
- 16 = EscalatedToTeam
- 32 = EscalatedToManager
- 64 = CreatedByEscalation
V2. AlertHistoryInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
acknowledgedAt
|
acknowledgedAt | date-time | |
|
Agradecimientos
|
acknowledgements | array of string | |
|
closedAt
|
closedAt | date-time | |
|
closedBy
|
closedBy | string | |
|
creado
|
created | date-time |
V2. AlertInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
eventId
|
eventId | string | |
|
ID externo
|
externalId | string | |
|
Banderas
|
flags | V2.AlertFlags |
|
|
historia
|
history | V2.AlertHistoryInfo | |
|
id
|
id | string | |
|
última modificación
|
lastModified | date-time | |
|
requiredAcknowledgements
|
requiredAcknowledgements | integer | |
|
severity
|
severity | V2.AlertSeverities |
|
|
estado
|
status | V2.AlertStatusDetails | |
|
ID de suscripción
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
texto
|
text | string | |
|
title
|
title | string | |
|
workflowType
|
workflowType | V2.AlertWorkflowTypes |
|
V2. AlertReportError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. AlertSettingsChannelType
V2. AlertSettingsDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
escEnabled
|
escEnabled | boolean | |
|
escMode
|
escMode | AlertEscalationModes |
|
|
escRefId
|
escRefId | string | |
|
filterAction
|
filterAction | AlertFilterActions |
|
|
filterMode
|
filterMode | AlertFilterModes |
|
|
notificationProfileOverrides
|
notificationProfileOverrides | array of V2.AlertSettingsNotificationProfileDetails | |
|
optOut
|
optOut | TeamCategoryOptOutModes |
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
persNotInterval
|
persNotInterval | integer | |
|
persNotMode
|
persNotMode | PersistentNotificationModes |
|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer | |
|
teamId
|
teamId | string |
V2. AlertSettingsError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. AlertSettingsNotificationProfileDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Canal
|
channel | V2.AlertSettingsChannelType |
|
|
delayInMinutes
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean |
V2. AlertSeverities
V2. AlertStatusCodes
- 0 = Ninguno
- 1 = Abrir
- 2 = Confirmado
- 4 = Cerrado
- 8 = NoReply
- 16 = Error
- 32 = Error
- 0 = Ninguno
- 1 = Abrir
- 2 = Confirmado
- 4 = Cerrado
- 8 = NoReply
- 16 = Error
- 32 = Error
V2. AlertStatusDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
alertDeliveryStatus
|
alertDeliveryStatus | V2.AlertDeliveryStatusDetails | |
|
código de estado
|
statusCode | V2.AlertStatusCodes |
|
V2. AlertWorkflowTypes
- 0 = Ninguno
- 1 = Usuario
- 2 = TeamBroadcast
- 3 = TeamEscalation
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
- 0 = Ninguno
- 1 = Usuario
- 2 = TeamBroadcast
- 3 = TeamEscalation
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
V2. AlertingPatternChannelType
V2. AlertingPatternDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
categories
|
categories | array of string | |
|
escalationSettings
|
escalationSettings | V2.AlertingPatternEscalationSettings | |
|
id
|
id | string | |
|
nombre
|
name | string | |
|
notificationProfileOverrides
|
notificationProfileOverrides | array of V2.AlertingPatternNotificationProfileDetails | |
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | |
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
overrideResponseSettings
|
overrideResponseSettings | boolean | |
|
responseSettings
|
responseSettings | V2.AlertingPatternResponseSettings | |
|
suppressSignl
|
suppressSignl | boolean | |
|
timeSlots
|
timeSlots | array of V2.TimeSlotDetails |
V2. AlertingPatternEscalationSettings
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
mode
|
mode | AlertEscalationModes |
|
|
referenceId
|
referenceId | string |
V2. AlertingPatternNotificationProfileDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Canal
|
channel | V2.AlertingPatternChannelType |
|
|
delayInMinutes
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean |
V2. AlertingPatternResponseSettings
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer |
V2. CalloutTemplateDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
ID externo
|
externalId | string | |
|
id
|
id | string | |
|
location
|
location | string | |
|
nombre
|
name | string | |
|
Asunto
|
subject | string | |
|
targetAllTeams
|
targetAllTeams | boolean | |
|
targetTeamId
|
targetTeamId | string | |
|
texto
|
text | string | |
|
workflowType
|
workflowType | V2.CalloutTemplateWorkflowType |
|
V2. CalloutTemplateWorkflowType
- 0 = AsConfiguredInTeam
- 2 = TeamBroadcast
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
- 0 = AsConfiguredInTeam
- 2 = TeamBroadcast
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
V2. CategoryAugmentationDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
id
|
id | string | |
|
nombre
|
name | string | |
|
type
|
type | V2.CategoryAugmentationType |
|
|
value
|
value | string |
V2. CategoryAugmentationType
V2. CategoryDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
augmentations
|
augmentations | array of V2.CategoryAugmentationDetails | |
|
color
|
color | string | |
|
Enriquecimientos
|
enrichments | array of V2.CategoryEnrichmentDetails | |
|
id
|
id | string | |
|
imageName
|
imageName | string | |
|
isDefault
|
isDefault | boolean | |
|
keywordMatching
|
keywordMatching | V2.KeywordMatchingType |
|
|
palabras clave
|
keywords | array of string | |
|
palabras claveExcluded
|
keywordsExcluded | array of string | |
|
nombre
|
name | string | |
|
options
|
options | V2.CategoryOptions |
|
|
order
|
order | integer | |
|
teamId
|
teamId | string |
V2. CategoryEnrichmentDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nombre
|
name | string | |
|
type
|
type | V2.CategoryEnrichmentType |
|
|
value
|
value | string |
V2. CategoryEnrichmentType
V2. CategoryError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. CategoryOptions
- 0 = Ninguno
- 1 = Oculto
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
- 0 = Ninguno
- 1 = Oculto
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
V2. ChannelType
- 0 = Ninguno
- 1 = Insertar
- 2 = Correo electrónico
- 4 = Bot
- 8 = Voz
- 16 = SMS
- 0 = Ninguno
- 1 = Insertar
- 2 = Correo electrónico
- 4 = Bot
- 8 = Voz
- 16 = SMS
V2. DutyChangeError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. DutyError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. DutyModes
V2. EventDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.EventParameterDetails | |
|
acknowledgedAlerts
|
acknowledgedAlerts | array of string | |
|
closedAlerts
|
closedAlerts | array of string | |
|
creationTime
|
creationTime | date-time | |
|
eventSourceGroupId
|
eventSourceGroupId | string | |
|
eventSourceId
|
eventSourceId | string | |
|
eventSourceTeamId
|
eventSourceTeamId | string | |
|
eventSourceType
|
eventSourceType | V2.EventSourceTypes |
|
|
eventStatus
|
eventStatus | V2.EventStatusCodes |
|
|
ID externo
|
externalId | string | |
|
desde
|
from | string | |
|
id
|
id | string | |
|
última modificación
|
lastModified | date-time | |
|
severity
|
severity | V2.EventSeverities |
|
|
targets
|
targets | array of V2.EventTargetDetails | |
|
texto
|
text | string | |
|
title
|
title | string |
V2. EventParameterDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nombre
|
name | string | |
|
options
|
options | V2.EventParameterOptions |
|
|
order
|
order | integer | |
|
type
|
type | V2.EventParameterTypes |
|
|
value
|
value | string |
V2. EventParameterOptions
V2. EventParameterTypes
- 0 = Ninguno
- 1 = Objeto
- 2 = Matriz
- 3 = Constructor
- 4 = Propiedad
- 5 = Comentario
- 6 = Entero
- 7 = Float
- 8 = Cadena
- 9 = Boolean
- 10 = Null
- 11 = Sin definir
- 12 = Fecha
- 13 = Sin procesar
- 14 = Bytes
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
- 0 = Ninguno
- 1 = Objeto
- 2 = Matriz
- 3 = Constructor
- 4 = Propiedad
- 5 = Comentario
- 6 = Entero
- 7 = Float
- 8 = Cadena
- 9 = Boolean
- 10 = Null
- 11 = Sin definir
- 12 = Fecha
- 13 = Sin procesar
- 14 = Bytes
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
V2. EventSeverities
V2. EventSourceEndpointError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. EventSourceTypes
- 0 = Ninguno
- 1 = Correo electrónico
- 2 = WebHook
- 3 = Script
- 4 = Sistema
- 5 = Manual
- 6 = Voz
- 7 = Api
- 0 = Ninguno
- 1 = Correo electrónico
- 2 = WebHook
- 3 = Script
- 4 = Sistema
- 5 = Manual
- 6 = Voz
- 7 = Api
V2. EventStatusCodes
- 0 = Ninguno
- 1 = Procesamiento
- 2 = Signled
- 3 = Filtrado
- 4 = Resuelto
- 5 = Descartado
- 6 = Confirmado
- 7 = Suprimido
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Error
- 0 = Ninguno
- 1 = Procesamiento
- 2 = Signled
- 3 = Filtrado
- 4 = Resuelto
- 5 = Descartado
- 6 = Confirmado
- 7 = Suprimido
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Error
V2. EventTargetDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
categoryId
|
categoryId | string | |
|
creationTime
|
creationTime | date-time | |
|
distributionId
|
distributionId | string | |
|
eventId
|
eventId | string | |
|
eventTargetStatus
|
eventTargetStatus | V2.EventTargetStatusCode |
|
|
id
|
id | string | |
|
última modificación
|
lastModified | date-time | |
|
teamId
|
teamId | string |
V2. EventTargetStatusCode
- 0 = Ninguno
- 1 = Procesamiento
- 2 = Signled
- 3 = Filtrado
- 4 = Resuelto
- 5 = Descartado
- 6 = Confirmado
- 7 = Suprimido
- 1000 = Error
- 0 = Ninguno
- 1 = Procesamiento
- 2 = Signled
- 3 = Filtrado
- 4 = Resuelto
- 5 = Descartado
- 6 = Confirmado
- 7 = Suprimido
- 1000 = Error
V2. HolidayDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Día
|
day | integer | |
|
month
|
month | V2.Month |
|
|
repetidor
|
repeating | boolean | |
|
año
|
year | integer |
V2. InvitationResult
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
errorMessage
|
errorMessage | string | |
|
invitedUser
|
invitedUser | V2.InvitedUserInfo | |
|
correcto
|
success | boolean |
V2. InvitedUserInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
mailAddress
|
mailAddress | string | |
|
roleId
|
roleId | string | |
|
estado
|
status | V2.UserStatus |
|
|
userId
|
userId | string |
V2. KeywordMatchingType
V2. Mes
- 0 = Anular conjunto
- 1 = enero
- 2 = febrero
- 3 = Marzo
- 4 = Abril
- 5 = Mayo
- 6 = junio
- 7 = julio
- 8 = agosto
- 9 = septiembre
- 10 = Octubre
- 11 = Noviembre
- 12 = diciembre
- 0 = Anular conjunto
- 1 = enero
- 2 = febrero
- 3 = Marzo
- 4 = Abril
- 5 = Mayo
- 6 = junio
- 7 = julio
- 8 = agosto
- 9 = septiembre
- 10 = Octubre
- 11 = Noviembre
- 12 = diciembre
V2. NotificationProfileDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Canal
|
channel | V2.ChannelType |
|
|
delayInMinutes
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean | |
|
options
|
options | integer | |
|
persistente
|
persistent | boolean |
V2. OverlappingTimeSlotsDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
refId
|
refId | string | |
|
timeSlots
|
timeSlots | array of V2.TimeSlotDetails |
V2. PermissionError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. PhoneNumberValidationStatus
- 0 = NotValidated
- 1 = Validado
- 2 = CountryNotSupported
- 0 = NotValidated
- 1 = Validado
- 2 = CountryNotSupported
V2. RemoteActionDefinitionDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteActionDefinitionParameterDetails | |
|
createdAt
|
createdAt | date-time | |
|
descripción
|
description | string | |
|
executorService
|
executorService | string | |
|
ID externo
|
externalId | string | |
|
id
|
id | string | |
|
nombre
|
name | string | |
|
código de estado
|
statusCode | V2.RemoteActionDefinitionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
type
|
type | V2.RemoteActionTypes |
|
|
version
|
version | integer |
V2. RemoteActionDefinitionParameterDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
controlType
|
controlType | V2.RemoteActionParameterControlTypes |
|
|
defaultValue
|
defaultValue | string | |
|
descripción
|
description | string | |
|
Nombre para mostrar
|
displayName | string | |
|
nombre
|
name | string | |
|
options
|
options | V2.RemoteActionParameterOptions |
|
|
order
|
order | integer | |
|
values
|
values | array of string |
V2. RemoteActionDefinitionStatus
V2. RemoteActionDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteActionParameter | |
|
acceso
|
access | array of V2.RemoteActionTeamAccessDetails | |
|
createdAt
|
createdAt | date-time | |
|
currentPrincipal
|
currentPrincipal | V2.RemoteActionPrincipalAccessDetails | |
|
definitionId
|
definitionId | string | |
|
definitionVersion
|
definitionVersion | integer | |
|
descripción
|
description | string | |
|
enabled
|
enabled | boolean | |
|
executorService
|
executorService | string | |
|
ID externo
|
externalId | string | |
|
id
|
id | string | |
|
nombre
|
name | string | |
|
código de estado
|
statusCode | V2.RemoteActionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
ID de suscripción
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
type
|
type | V2.RemoteActionTypes |
|
V2. RemoteActionInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
acceso
|
access | array of V2.RemoteActionTeamAccessDetails | |
|
createdAt
|
createdAt | date-time | |
|
currentPrincipal
|
currentPrincipal | V2.RemoteActionPrincipalAccessDetails | |
|
definitionId
|
definitionId | string | |
|
descripción
|
description | string | |
|
enabled
|
enabled | boolean | |
|
id
|
id | string | |
|
nombre
|
name | string | |
|
código de estado
|
statusCode | V2.RemoteActionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
ID de suscripción
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
type
|
type | V2.RemoteActionTypes |
|
V2. RemoteActionParameter
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
controlType
|
controlType | V2.RemoteActionParameterControlTypes |
|
|
Nombre para mostrar
|
displayName | string | |
|
nombre
|
name | string | |
|
options
|
options | V2.RemoteActionParameterOptions |
|
|
order
|
order | integer | |
|
value
|
value | string | |
|
values
|
values | array of string |
V2. RemoteActionParameterControlTypes
- 0 = Texto
- 1 = MultiLineText
- 2 = Entero
- 3 = Double
- 4 = Bool
- 5 = Hora
- 6 = Fecha
- 7 = Zona horaria
- 8 = Contraseña
- 9 = PIN
- 10 = SingleChoice
- 11 = MultiChoice
- 12 = Sugerencia
- 0 = Texto
- 1 = MultiLineText
- 2 = Entero
- 3 = Double
- 4 = Bool
- 5 = Hora
- 6 = Fecha
- 7 = Zona horaria
- 8 = Contraseña
- 9 = PIN
- 10 = SingleChoice
- 11 = MultiChoice
- 12 = Sugerencia
V2. RemoteActionParameterOptions
- 0 = Ninguno
- 1 = Obligatorio
- 2 = Bloqueado
- 4 = Cifrado
- 0 = Ninguno
- 1 = Obligatorio
- 2 = Bloqueado
- 4 = Cifrado
V2. RemoteActionPrincipalAccessDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
canEdit
|
canEdit | boolean | |
|
canExecute
|
canExecute | boolean |
V2. RemoteActionStatus
- 0 = Deshabilitado
- 1 = Habilitado
- 2 = No válido
- 4 = ProviderDisabled
- 0 = Deshabilitado
- 1 = Habilitado
- 2 = No válido
- 4 = ProviderDisabled
V2. RemoteActionTeamAccessDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
canEdit
|
canEdit | boolean | |
|
canExecute
|
canExecute | boolean | |
|
teamId
|
teamId | string |
V2. RemoteActionTypes
- 0 = Desconocido
- 1 = Script
- 2 = EnterpriseAlert
- 3 = Webhook
- 0 = Desconocido
- 1 = Script
- 2 = EnterpriseAlert
- 3 = Webhook
V2. RemoteJob
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteJobParameter | |
|
actionId
|
actionId | string | |
|
activatedAt
|
activatedAt | date-time | |
|
createdAt
|
createdAt | date-time | |
|
creatorInfo
|
creatorInfo | V2.RemoteJobCreatorDetails | |
|
definitionId
|
definitionId | string | |
|
ID externo
|
externalId | string | |
|
id
|
id | string | |
|
lastUpdate
|
lastUpdate | date-time | |
|
options
|
options | V2.RemoteJobOptions |
|
|
startedAt
|
startedAt | date-time | |
|
código de estado
|
statusCode | V2.RemoteJobStatusCodes |
|
|
statusDescription
|
statusDescription | string | |
|
detalles del estado
|
statusDetails | string | |
|
type
|
type | V2.RemoteActionTypes |
|
V2. RemoteJobCreatorDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
referenceId
|
referenceId | string | |
|
referenceName
|
referenceName | string | |
|
type
|
type | V2.RemoteJobCreatorType |
|
V2. RemoteJobCreatorType
V2. RemoteJobOptions
V2. RemoteJobParameter
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string | |
|
value
|
value | string |
V2. RemoteJobStatusCodes
- 0 = Ninguno
- 1 = Pendiente
- 2 = Listo
- 4 = En ejecución
- 8 = Ejecutado
- 16 = Error
- 0 = Ninguno
- 1 = Pendiente
- 2 = Listo
- 4 = En ejecución
- 8 = Ejecutado
- 16 = Error
V2. ScheduleDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
end
|
end | date-time | |
|
id
|
id | string | |
|
options
|
options | integer | |
|
start
|
start | date-time | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. TeamDutySettingsDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
autosnapEnabled
|
autosnapEnabled | boolean | |
|
dutyAssistantEnabled
|
dutyAssistantEnabled | boolean | |
|
dutyChangeNotificationsEnabled
|
dutyChangeNotificationsEnabled | boolean | |
|
dutyLength
|
dutyLength | integer | |
|
handoverDate
|
handoverDate | date-time | |
|
handoverTime
|
handoverTime | integer | |
|
handoverWeekDay
|
handoverWeekDay | integer | |
|
minMemberOnDuty
|
minMemberOnDuty | integer | |
|
schedulingEnabled
|
schedulingEnabled | boolean | |
|
shiftReportCarbonCopyMail
|
shiftReportCarbonCopyMail | string | |
|
shiftReportEnabled
|
shiftReportEnabled | boolean | |
|
teamId
|
teamId | string | |
|
timezone
|
timezone | string |
V2. TeamDutySettingsError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. TeamDutySummaryError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
userId
|
userId | string |
V2. TeamHolidayDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
vacaciones
|
holidays | array of V2.HolidayDetails | |
|
teamId
|
teamId | string |
V2. TeamImageDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contenido
|
content | byte | |
|
contentDispostion
|
contentDispostion | string | |
|
contentEncoding
|
contentEncoding | string | |
|
tipo de contenido
|
contentType | string | |
|
última modificación
|
lastModified | date-time | |
|
nombre
|
name | string |
V2. TeamMembershipDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
mailAddress
|
mailAddress | string | |
|
memberSince
|
memberSince | date-time | |
|
roleId
|
roleId | string | |
|
estado
|
status | V2.UserStatus |
|
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. TeamPermissions
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
permissions
|
permissions | array of UserPermission | |
|
teamId
|
teamId | string |
V2. TeamPrivacySettingsDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
hideContactAddresses
|
hideContactAddresses | boolean | |
|
hideDutyData
|
hideDutyData | boolean | |
|
hideForEscalation
|
hideForEscalation | boolean | |
|
teamId
|
teamId | string |
V2. TeamPublicDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nombre
|
name | string | |
|
privacySettings
|
privacySettings | V2.TeamPrivacySettingsDetails |
V2. TeamUserError
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de error
|
errorCode | integer | |
|
descripción del error
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. TimeSlotDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
end
|
end | V2.WeekTimeDetails | |
|
id
|
id | string | |
|
start
|
start | V2.WeekTimeDetails |
V2. TimeSlotValidationResultDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
isOverlapping
|
isOverlapping | boolean | |
|
item
|
item | V2.TimeSlotDetails | |
|
overlappingTimeSlots
|
overlappingTimeSlots | array of V2.OverlappingTimeSlotsDetails | |
|
válido
|
valid | boolean |
V2. UserDeliveryStatus
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | V2.UserDeliveryStatusCodes |
|
|
userId
|
userId | string |
V2. UserDeliveryStatusCodes
- 0 = Ninguno
- 1 = Abrir
- 2 = Error
- 4 = Transmitido
- 6 = Entregado
- 8 = Protegido
- 9 = AbusoProtected
- 24 = ParcialmenteTransmitted
- 26 = ParcialmenteDelivered
- 30 = NotOnDuty
- 31 = CategoryOptOut
- 32 = NoMessagesSent
- 0 = Ninguno
- 1 = Abrir
- 2 = Error
- 4 = Transmitido
- 6 = Entregado
- 8 = Protegido
- 9 = AbusoProtected
- 24 = ParcialmenteTransmitted
- 26 = ParcialmenteDelivered
- 30 = NotOnDuty
- 31 = CategoryOptOut
- 32 = NoMessagesSent
V2. UserDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
colorIndex
|
colorIndex | integer | |
|
contactAddresses
|
contactAddresses | array of | |
|
dutyInfos
|
dutyInfos | array of V2.UserDutyDetails | |
|
externalAuthProvider
|
externalAuthProvider | string | |
|
id
|
id | string | |
|
isDeactivated
|
isDeactivated | boolean | |
|
isInvite
|
isInvite | boolean | |
|
lastSeen
|
lastSeen | date-time | |
|
correo
|
string | ||
|
nombre
|
name | string | |
|
remoteActionPinSet
|
remoteActionPinSet | boolean | |
|
ID de suscripción
|
subscriptionId | string | |
|
timeZone
|
timeZone | string | |
|
userImageLastModified
|
userImageLastModified | date-time |
V2. UserDutyDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
dutyMode
|
dutyMode | V2.DutyModes |
|
|
lastChange
|
lastChange | date-time | |
|
onDutyTime
|
onDutyTime | integer | |
|
atrasado
|
overdue | boolean | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. UserLocaleResponseDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
lenguaje
|
language | string | |
|
timeZone
|
timeZone | string |
V2. UserPhoneNumberDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
countryCode
|
countryCode | string | |
|
número de teléfono
|
phoneNumber | string | |
|
validationStatus
|
validationStatus | V2.PhoneNumberValidationStatus |
|
V2. UserStatus
- 0 = Ninguno
- 1 = Eliminado
- 2 = Invitado
- 3 = Activo
- 0 = Ninguno
- 1 = Eliminado
- 2 = Invitado
- 3 = Activo
V2. WeekTimeDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
hora
|
hour | integer | |
|
minutes
|
minutes | integer | |
|
día laborable
|
weekday | V2.Weekday |
|
V2. Día laborable
- 0 = Vacaciones
- 1 = Lunes
- 2 = Martes
- 3 = Miércoles
- 4 = Jueves
- 5 = Viernes
- 6 = Sábado
- 7 = Domingo
- 0 = Vacaciones
- 1 = Lunes
- 2 = Martes
- 3 = Miércoles
- 4 = Jueves
- 5 = Viernes
- 6 = Sábado
- 7 = Domingo
WebhookInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
descripción
|
description | string | |
|
enabled
|
enabled | boolean | |
|
extUrl
|
extUrl | string | |
|
id
|
id | string | |
|
nombre
|
name | string | |
|
subId
|
subId | string | |
|
teamId
|
teamId | string |
cuerda / cadena
Este es el tipo de datos básico "string".
binary
Este es el tipo de datos básico "binary".