Testing the UCA REST connection

Last Updated : Apr 09, 2021 |

About this task

Use this procedure to test the UCA REST connection.

Note:

By default, UCA requires an authentication token to be supplied in REST request headers. For testing or troubleshooting purposes, you must enable tokenless access by setting the Enable Tokenless Access attribute of UCAStoreService to TRUE. The change is effective as soon as System Manager replicates the setting to the nodes. After you complete the testing or troubleshooting, you must reset this attribute to FALSE.

Before you begin

Ensure that Avaya Oceana® Cluster 1 is in the running and accepting state.

Procedure

Perform one of the following steps to view all Providers:

  1. In your web browser, enter the following URL:

    https://<AvayaOceanaCluster1_FQDN>/services/UCAStoreService/uca/providers

  2. Perform the following steps:
    1. Install a REST client on your Internet browser. For example, Postman application on Chrome.
    2. In the Get field, enter the following request URL:

      https://<AvayaOceanaCluster1_FQDN>/services/UCAStoreService/uca/providers

    3. Click Send.

    The test returns one of the following results:

    • On a newly created system, the test returns an empty JSON block ([ ]).

    • On a system with providers configured, the test returns the provider information in JSON format.

    Note:

    If the test returns an HTTP error, you must investigate and resolve the error.