uimapi Call Reference

uimpga-ga
uimapi includes improvements over webservices_rest. You now have access to modern Swagger documentation and endpoints to work with the APIs. The uimapi REST API endpoints are provided within a self-documenting framework that lets you try the methods and see the generated responses.
URL Structure
All URLs mentioned are relative to the uimapi REST web services base URL, which is:
http://<hostname>:<port>/uimapi
Authentication Header
The uimapi REST web services use HTTP basic access authentication.
Access the Swagger Documentation
After uimapi is installed, browse to the following address to access the Swagger documentation for the uimapi web services:
http://<hostname>:<port>/uimapi/swagger-ui.html
The following example screenshot shows the Swagger interface. This interface displays some of the RESTful web services that uimapi provides:
Snap245.jpg
Encoding Request Parameters
For GET and DELETE request parameters you need to encode the 'Key' using an encoding tool before you click
Try it out!
For example, if the 'Key' value is
/disk/alarm/fixed/C:\/warning/active
, then the encoded value is
%2Fdisk%2Falarm%2Ffixed%2FC%3A%5C%2Fwarning%2Factive
which should be used as the 'Key 'request.
Supported Resource Types
The following uimapi resource types are available on Swagger:
  • accounts
  • acls
  • alarms
  • archive
  • configuration_items
  • contact_origins
  • contacts
  • custom_properties
  • deployment_jobs
  • devicegroups
  • deviceoperations
  • devices
  • groups
  • hubs
  • inventory
  • maintenance_mode
  • metrics
  • origins
  • packages
  • policy
  • probes
  • profiles
  • robots
  • service_level_agreements
  • service_level_objectives
  • templates
  • user-controller
  • version
MCS APIs
The following MCS related APIs are added in UIMAPI for offering the MCS functionality.
Operation Name
Type Of Operation
URI Path
Description of Operation
devicegroups
GET
/devicegroups
Retrieve list of device groups
POST
/devicegroups
Creates a new Device Group
GET
/devicegroups/container
Retrieve list of device groups Without Container
GET
/devicegroups/getAllParentContainerGroupForDevice/{csId}
Get all parent container or device group for device
GET
/devicegroups/getAllUniqueDevices/{deviceGrpId}
Get all devices part of given container or device group
DELETE
/devicegroups/{mcs_grp_id}
Deletes a group
GET
/devicegroups/{mcs_grp_id}
Get group by ID
PUT
/devicegroups/{mcs_grp_id}
Update device group
GET
/devicegroups/{mcs_grp_id}/members
Get members of a device group
DELETE
/devicegroups/{mcs_grp_id}/members/{identifier}
Remove device from group (Static Group Only)
PUT
/devicegroups/{mcs_grp_id}/members/{identifier}
Adds a member to a group (Static Group Only)
GET
/devicegroups/{mcs_grp_id}/profiles
Gets profiles for group
POST
/devicegroups/{mcs_grp_id}/profiles
Adds a profile to the specified group with cm_group_id as input
PUT
/devicegroups/{mcs_grp_id}/profiles/{mcs_profile_id}
Update group profile
GET
/devicegroups/{mcs_grp_id}/templates
Retrieve all available templates for the group
GET
/devicegroups/{mcs_grp_id}/templates/{mcs_template_id}/blueprint
Gets blueprint for a template by template id and groupid
deviceoperations
GET
/deviceoperations
Lists all devices
POST
/deviceoperations
Create a SSRV2device
DELETE
/deviceoperations/{identifier}
Delete a SSRV2device
GET
/deviceoperations/{identifier}
Gets the specified device by lookup value
PUT
/deviceoperations/{identifier}
Update a SSSRV2device
GET
/deviceoperations/{identifier}/customattributes
Get custom attributes for device
GET
/deviceoperations/{identifier}/groups
Get groups the specified device is a member of
GET
/deviceoperations/{identifier}/packages
Get packages for device
DELETE
/deviceoperations/{identifier}/packages/{mcs_pkg}
Remove a package from a device
PUT
/deviceoperations/{identifier}/packages/{mcs_pkg}
Adds package to device
GET
/deviceoperations/{identifier}/profiles
Get all profiles for device
POST
/deviceoperations/{identifier}/profiles
Create a device profile
DELETE
/deviceoperations/{identifier}/profiles/{mcs_profile_id}
Delete a device profile
GET
/deviceoperations/{identifier}/profiles/{mcs_profile_id}
Get profile directly instead
PUT
/deviceoperations/{identifier}/profiles/{mcs_profile_id}
Update a profile for a device
PUT
/deviceoperations/{identifier}/suspend
Suspend a device
GET
/deviceoperations/{identifier}/templates
Gets the valid templates for the specified device
GET
/deviceoperations/{identifier}/templates/{mcs_template_id}/blueprint
Get blueprint directly from template instead
PUT
/deviceoperations/{identifier}/unsuspend
Unsuspend a device
packages
GET
/v0/packages
Get a list of packages
GET
/v0/packages/{mcs_pkg_name}/templates
Get a list of Packagetemplates
templates
GET
/v0/templates
Get templates
GET
/v0/templates/{mcs_template_id}/blueprint
Get a blueprint for the specified template
maintenance_mode
GET
/maintenance_mode/{domain}/{hub}/{robot}/get_all_maintenance_schedules
Gets a list of maintenance schedules and its properties
GET
/maintenance_mode/{domain}/{hub}/{robot}/get_maintenance_schedule/{schedule_id}
Gets the details of maintenance schedule individually
POST
/maintenance_mode/{domain}/{hub}/{robot}/add_groups_to_maintenance_schedule/{schedule_id}
Adds a static group (cs_ids) to the maintenance schedule
POST
/maintenance_mode/{domain}/{hub}/{robot}/remove_groups_from_maintenance_schedule/{schedule_id}
Removes the static groups (cs_ids) from the maintenance schedule
GET
/maintenance_mode/{domain}/{hub}/{robot}/get_maintenance_schedules/{cs_id}
Gets a list of maintenance schedules linked with a computer system
GET
/maintenance_mode/{domain}/{hub}/{robot}/get_computer_systems_for_maintenance_schedule/{schedule_id}
Gets a list of computer system(s) ids linked with a maintenance schedule