UIMAPI Deployment and Configuration
search cancel

UIMAPI Deployment and Configuration

book

Article ID: 265883

calendar_today

Updated On:

Products

DX Unified Infrastructure Management (Nimsoft / UIM) CA Unified Infrastructure Management On-Premise (Nimsoft / UIM) CA Unified Infrastructure Management SaaS (Nimsoft / UIM)

Issue/Introduction

How to deploy and configure the UIMAPI package in DX UIM?

Environment

  • Release: UIM 20.3/20.4
  • Component: UIMAPI Package

Resolution

The uimapi package needs to be installed on the OC (starting from 20.3) to use the UIMAPI webservices

Once this package is installed, you may open swagger UI to run tests and get results

  1. http://##.###.###.###/uimapi/swagger-ui/index.html

  1. This offers many endpoints such as accounts, robots, domains, alarms etc as shown below

  1. To query robots endpoint, click here and then filter on available options such as “devid, domain, hub, robotName, ip, usertag1, usertag2 and origin

For ex: to get list of Robots from a specific hub, enter hub name “UIMPRI_hub”, hit “Execute”

  1. The results are as below
    1. The “request URL” is http://##.###.###.###:80/uimapi/robots?hub=UIMPRI_hub
    2. Response Code is 200 (Successful)

Note: Below is the POSTMAN UI configuration