UIMAPI - List the probes of a robot
search cancel

UIMAPI - List the probes of a robot

book

Article ID: 265555

calendar_today

Updated On:

Products

DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

Is there an API method to list the probes of a specific robot?

Environment

DX UIM 20.4.* / 23.4

Cause

Guidance

Resolution

It is possible to list the probes under a certain robot using the UIMAPI controller callback type of request. 

This is achieved with one of the probe calls:  

​/uimapi​/probes​/{domain}​/{hub}​/{robot}​/{probe}​/callback​/{callback}

Returns a UIM PDS structure with the information requested from the callback of the UIM probe specified

 

Example Request URL: 

http://##.##.###.##:80/uimapi/probes/domain_name/hub_name/robotname/controller/callback/probe_list


From the response body that is returned, extract the /pds/entry/name property to get the names of all the probes under the specified robot. 

 

Additional Information

See Swagger page for a list of all api calls.

See this link for 20.4CU4 or lower.

   http://<OC ip or hostname>/uimapi/swagger-ui.html

See this link for 20.4 CU4 or higher.

   http://<OC ip or hostname>/uimapi/swagger-ui/index.html