Rest Api Action

Rest Api Action icon

Lida com chamadas RESTful API simultaneamente. Esta ação permite que o sistema lide com cargas maiores. Ela retorna o corpo e os cabeçalhos da chamada API. Isso torna mais fácil testar e depurar scripts.

Para testar um script que contém uma opção REST API e ver informações de resposta, você deve executar o script. Execute o script usando a opção Iniciar com rastreamento.

Você também pode fazer chamadas REST API simultâneas usando a função GetRestProxy em uma ação SNIPPET. Esta opção não lida com cargas tão altas quanto a ação REST API.

Dependencies

Existem limitações para o uso desta ação. As limitações são impostas para unidades de negócios Alto nível de agrupamento organizacional usado para gerenciar o suporte técnico, cobrança e configurações globais para o seu ambiente CXone de forma que um(a) não cause impacto no(a) outro(a). As limitações dentro do plataforma são:

Formato de resposta: apenas o formato de resposta JSON é compatível.
Novas tentativas em caso de falha: o manipulador de ações tentará automaticamente duas vezes se uma mensagem de falha for recebida antes de retornar a resposta.
Tempo limite: você especifica o valor de tempo limite na solicitação. O valor não pode ser superior a 90 segundos.
Tamanho máximo de resposta: o tamanho máximo da resposta é 32KB. Isso é consistente com a funcionalidade de Snippet existente.
Limite do acelerador: o limite de aceleração é definido por dois parâmetros:
- Máximo de solicitações simultâneas: até 100 solicitações simultâneas são permitidas por padrão. Este limite é o mesmo para todos os clientes do CXone. Isso significa que 100 solicitações simultâneas resultam em uma taxa de transferência muito maior do que a funcionalidade Snippet existente. Se você precisar de mais de 100 solicitações simultâneas, converse com seu Representante de Contas do CXone sobre como aumentar o limite da sua unidade de negócios. Aprovações especiais são necessárias.
- Contagem de filas: quando as solicitações excedem o limite, as solicitações extras entram em uma fila de processamento. Quando as solicitações ficam abaixo do limite, as solicitações enfileiradas são processadas.
Disjuntor: se o URL especificado estiver inativo ou inacessível, você poderá receber muitas falhas na sua solicitação. Quando isto acontecer, o CXone recuará (ou seja, reduzirá) a execução da solicitação de TODOS OS URLS da ação REST API por um período de tempo. Isso permite que seu URL especificado se recupere da falha. Os limites são identificados abaixo.
- Tempo de recuo ou duração do intervalo: se a taxa de falha for atingida, nenhuma solicitação da ação REST API será executada por 30 segundos.
- Taxa de transferência mínima: 100 solicitações por segundo. Se a sua unidade de negócios não estiver executando o número mínimo de solicitações, ele(a) continuará executando suas solicitações mesmo que as solicitações estejam falhando.
- Taxa de falha: se 50% das solicitações falharem em 30 segundos, suas solicitações não serão executadas nos 30 segundos seguintes. 30 segundos é uma janela rolante.

Input Properties

Estas propriedades definem dados que a ação usa durante a execução.

Propriedade	Descrição
legenda	Insira uma frase curta que identifica exclusivamente esta ação no script. A legenda aparece na tela do script no ícone da ação. The default is the action name.
Verb	Oferece suporte a ações REST básicas, como GET, PUT, POST, DELETE e PATCH.
Parameters	Suporta a capacidade de especificar parâmetros de consulta ou publicar quaisquer dados. Qualquer tipo de JSON - Jobject, Jarray, Jtoken deve ser aceitável. Atualmente, a ação requer que JSON seja fornecido em uma única linha. A substituição de variável a partir de uma string contendo JSON ou a conversão de tipo de dados dinâmicos para JSON usando a função asjson() são suportados. Você também pode passar a variável de saída resultSet(out) de uma ação REST API anterior para essa propriedade.
Headers	Suporta a capacidade de adicionar cabeçalhos personalizados para permitir a autenticação do cliente (como tokens do portador). Pares de valores-chave expressos no formato JSON são aceitos. Esta ação requer que o JSON seja fornecido em uma única linha. A substituição de variável a partir de uma string contendo JSON ou a conversão de tipo de dados dinâmicos para JSON usando a função asjson() são suportados. Você também pode passar a variável de saída resultSet(out) de uma ação REST API anterior para essa propriedade também. Importante Se seu terminal de URL customizado requer cabeçalhos diferentes, ele deve ser especificado nesta propriedade. Para manter a paridade de recursos com a ação Snippet existente, CXone adiciona os seguintes cabeçalhos. {"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}
Command	A única opção é MakeRestRequest, que funciona da mesma maneira quando usada em uma action Snippet. O desenvolvimento futuro pode oferecer comandos adicionais que a ação Snippet fornece.
TimeOutInMilliSeconds	Permite que um tempo limite da chamada REST seja especificado e respeitado. Deve ter menos de 90 segundos (90000 milissegundos). Se nenhum tempo limite for especificado, o padrão é 10 segundos (10000 milésimos de segundo).
Service Address	Permite que um URL personalizado seja fornecido, incluindo a capacidade de especificar parâmetros de consulta para um GET. Substituição variável também é suportada.

Propriedades de saída

Estas propriedades contêm variáveis que armazenam dados retornados da execução da ação. Elas estão disponíveis para referência e uso quando a ação é concluída.

Propriedade	Descrição
resultSet(out)	A propriedade que contém qualquer informação retornada do API especificado no Endereço do serviço. Na janela de rastreamento Studio, ela aparece como Dynamic Object para fins de exibição. Você também pode passar esta resultSet como está no cabeçalho e nos parâmetros, se necessário.
errorArgList(out)	As condições de erro têm um objeto como o proxy REST para compatibilidade. Suporta tipo DynamicData.

Condições de ramal resultante

Condições de ramal resultante permitem que você crie ramais no seu script para atender diferentes resultados quando uma ação é executada.

Condição	Descrição
Throttle	Caminho percorrido quando muitas solicitações são executadas dentro de um curto período de tempo. Veja as limitações abaixo para mais detalhes.
InvalidInput	Caminho percorrido se uma entrada inválida for encontrada ou ocorrer um erro de tempo limite. Cada parâmetro é validado quando o script é salvo.
Failure	Caminho seguido quando ocorre algum erro ou exceção no NICE CXone aplicativo que está executando a solicitação.
Error	Caminho percorrido quando o terminal do cliente remoto retorna um código de erro http.
Default	Caminho seguido quando a resposta não é recebida em 90 segundos.
Success	Caminho seguido se a ação for concluída sem erros e quaisquer chamadas de API ou retornos de dados foram bem-sucedidos (códigos de resposta 2xx).

Other Options

Você pode substituir solicitações de API RESTful externas atualmente concluídas na action Snippet.