Call Reference

Contents
uim835
Contents
All URLs mentioned are relative to the REST web services base URL which is:
http(s)://<your_UMP_address>:<your_UMP_port>/rest
In the sample HTTP-Requests and HTTP–Responses, certain header information (such as authentication headers) is omitted. This means that the listed requests will not work if sent directly to the interface. The purpose of those samples is to illustrate the data structure that used when invoking the calls.
WADL Description
The RESTful web services interface offers an automatically generated web application description file that specifies all exposed service calls and structures.
This file is available on your UMP at:
http://<your_UMP_address>/rest/application.wadl
General Information on Paging
Many calls to retrieve list information support paging. On those that do, it is indicated in the URL of the call within the optional parameter setting:
?maxrows=X&offset=Y
The parameter
maxrows
defines how many rows the result should contain in maximum (maxrows=5 returns 5 entries maximum).  If the list contains a lesser number of rows, all rows are returned.
The second parameter offset can only be used if maxrows is also set.
Offset
defines from where to fetch the number of entries defined in maxrows. For example, if the list contains 20 entries in total, then
?maxrows=5&offset=10
returns entries numbered 10 through 15 in the list.
http(s)://<your_UMP_address>:<your_UMP_port>/rest
More information: