Working with the Swagger UI

You can make the API calls in the Swagger UI immediately after you are logged in and authorized. You might use the Swagger UI to work with the Probable Cause API and to retrieve metrics data with the metric anomaly detection API. Complete the following steps to authorize at the Swagger UI.

1. Generate an API key:
   1. Open the Netcool® Operations Insight® UI and click API Keys on the event management Administration page.
   2. Click New API key.
   3. Enter a description for the key in API key description.
   4. Specify which part of the event management API the key provides access to. Go to Permissions and ensure that only those check boxes are selected that you want the key to provide access to. All APIs are selected by default. Clear the ones that you do not want the API key to provide access to.
      
      Important: Make a note of the APIs the key provides access to. For example, note it in the description you enter for the key. You cannot view or change which APIs were selected for the key later.
   5. Click Generate. A new name and password are generated. Make a note of these values.
      Important: The password is hidden by default. To view and be able to copy the password, set Display password to Show. Ensure you make a note of the password. For security reasons, the password cannot be retrieved later. If you lose the password, you must delete the API key and generate a new one.
   6. Click the icon next to Manage API keys to view the base URL for the API.
2. Login into Swagger by using the API key that you generated. From the Swagger header section, click Authorize and enter the API key name and API key password in the login dialog and click Authorize again.
3. Read through the possible actions available on the Swagger UI and choose the one you want to perform.
4. Configure the API action that you want to perform by following the API documentation present on the Swagger UI.
5. Run the action and check the resulting response code.