Rest Api Action

This help page is for Desktop Studio. This information is also available for CXone Studio.

Rest Api Action icon

Maneja de manera sincrónica las llamadas de la API RESTful. Esta acción permite que el sistema maneje cargas mayores. Devuelve tanto el cuerpo como los encabezados de la llamada a la API. Esto facilita la prueba y depuración de scripts.

Para hacer pruebas a un script que contenga una opción de la API REST y ver la información de respuesta, debe ejecutar el script. Ejecutar el script usando la opción Iniciar con Trace

También puede hacer llamadas síncronas de la API REST utilizando la función GetRestProxy en una acción SNIPPET. Esta opción no tolera cargas tan altas como la acción de la API REST.

Dependencies

Existen limitaciones en el uso de esta acción. Se imponen limitaciones en el nivel de tenantCerrado Agrupación organizativa de alto nivel utilizado para administrar el soporte técnico, facturación y configuración global para su CXone entorno para que uno no impacte al otro. Las limitaciones dentro del Plataforma son:

  • Formato de respuesta: Solo se admite el formato de respuesta JSON.
  • Reintentos en caso de falla: El gestionador de acciones intentará automáticamente dos veces si se recibe una falla antes de regresar la respuesta.
  • Tiempo en espera: Usted especifica el valor de tiempo de espera en la solicitud. El valor no puede ser superior a 90 segundos.
  • Tamaño máximo de respuesta: El tamaño máximo de respuesta es de 32 KB. Esto está en consonancia con la funcionalidad Snippet existente.
  • Límite de aceleración: El límite de aceleración está definido por 2 parámetros:
    • Solicitudes simultáneas máximas:°De forma predeterminada, se permiten hasta 100 solicitudes simultáneas. Este límite es el mismo para todos los clientes CXone. Esto implica que 100 solicitudes simultáneas dan como resultado un rendimiento mucho mayor que el de la funcionalidad Snippet existente. Si necesita más de 100 solicitudes simultáneas, hable con su Representante de cuenta CXone acerca de aumentar el límite para sutenant. Se requieren aprobaciones especiales.
    • Conteo en cola: Cuando las solicitudes exceden el límite, las solicitudes adicionales ingresan a una cola de procesamiento. Una vez que las solicitudes caen por debajo del límite, se procesan las solicitudes en cola.
  • Cortacircuitos: Si su URL especificada está inactiva o no se puede ingresar a ella, puede obtener varias fallas en su solicitud. Cuando sucede esto, CXone retrocederá (es decir, reducirá) la ejecución de solicitudes de TODAS las URL desde la acción REST API durante un tiempo. Esto permite que su URL especificada se recupere del error. Los límites se identifican a continuación.
    • Tiempo de Retroceso o Duración de la Pausa: Si se alcanza la tasa de fallas, no se ejecutarán las solicitudes de la acción REST API durante 30 segundos.
    • Rendimiento mínimo: 100 solicitudes por segundo. Si su tenant no está ejecutando la cantidad mínima de solicitudes, continuará ejecutando sus solicitudes aunque las solicitudes estén fallando.
    • Tasa de fallas: Si fallaron el 50% de las solicitudes durante 30 segundos, no se ejecutarán sus solicitudes durante los siguientes 30 segundos. 30 segundos es una ventana rodante.

Input Properties

Estas propiedades definen los datos que utiliza la acción al ejecutarse.

Propiedad

Descripción

Leyenda

Ingrese una frase corta que identifique de forma única esta acción en el script. La leyenda aparece en el lienzo del script debajo del ícono de acción. The default is the action name.

Verb

Admite acciones de REST básicas como GET, PUT, POST, DELETE y PATCH.

Parameters

Admite la capacidad de especificar parámetros de consulta o publicar cualquier dato. Cualquier tipo de JSON: Jobject, Jarray, Jtoken debería ser aceptable. Actualmente, la acción requiere que JSON se proporcione en una sola línea. Se admite la sustitución de variables de una cadena que contiene JSON o la conversión del tipo de Datos Dinámicos a JSON usando la asjson() función. También puede pasar la variable de salida resultSet(out) de una acción previa REST API a esta propiedad.

Headers

Admite la capacidad de agregar encabezados personalizados para permitir la autenticación del cliente (como tokens de portador). Se aceptan pares de valores clave expresados en formato JSON. Esta acción requiere que JSON se proporcione en una sola línea. Se admite la sustitución de variables de una cadena que contiene JSON o la conversión del tipo de Datos Dinámicos a JSON usando la función asjson(). También puede pasar la variable de salida resultSet(out) de una acción previa REST API a esta propiedad.

Importante Si su punto final de URL personalizado requiere encabezados diferentes, debe especificarse en esta propiedad. Para mantener la paridad de características con la acción Snippet existente, CXone agrega los siguientes encabezados.

{"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}

Command

La única opción es MakeRestRequest, que funciona igual que cuando se usa en una Snippet action. Los desarrollos futuros pueden ofrecer otros comandos que proporciona la acción Snippet.

TimeOutInMilliSeconds

Permite especificar y respetar un tiempo de espera de la llamada REST. Debe ser menos de 90 segundos (90000 milisegundos). Si no se especifica ningún tiempo límite, el valor predeterminado es de 10 segundos (10000 milisegundos).

Service Address

Permite que se proporcione una URL personalizada, incluida la capacidad de especificar parámetros de consulta para un GET. También se admite la sustitución de variables.

Propiedades de salida

Estas propiedades contienen variables que incluyen datos que se evuelven al ejecutar la acción. Están disponibles como referencia y para usarse cuando se completa la acción.

Propiedad

Descripción

resultSet(out)

La propiedad que contiene cualquier información devuelta desde la API que se especifica en la Dirección de Servicio En lal ventana de rastreo Studio aparece como Dynamic Object con fines de visualización. También puede transferir este resultSet como está en el encabezado y los parámetros de ser necesario.

errorArgList(out)

Las condiciones de error tienen un objeto como el proxy REST para compatibilidad. Admite el tipo DynamicData.

Condiciones de la rama de resultados

Las condiciones de las ramas de resultados le permiten crear ramas en su script para manejar diferentes resultados cuando se ejecute una acción.

Condición

Descripción

Throttle

Ruta tomada cuando se ejecutan demasiadas solicitudes en un período corto de tiempo. Consulte las limitaciones a continuación para obtener más detalles.

InvalidInput

Ruta tomada si se encuentra una entrada no válida o se produce un error de tiempo de espera. Cada parámetro se valida cuando se guarda el script.

Failure

Camino tomado cuando ocurre algún error o excepción dentro del NICE CXoneAplicaciónejecutando la solicitud.

Error

Ruta tomada cuando el punto final del cliente remoto devuelve un código de error http.

Default

Camino tomado cuando la respuesta no se recibe dentro de los 90 segundos.

Success

Ruta que se toma si la acción finaliza sin errores y cualquier llamada API o devolución de datos se realiza correctamente (códigos de respuesta 2xx).

Other Options

Puede reemplazar las solicitudes API RESTful externas que actualmente están finalizadas en la Snippet action.