OMS endpoints
This list shows the methods and endpoints available for OMS. Using them you can accomplish nearly any task you can imagine to control or configure OMS.
Base URI: https://hostname/oms/api/
Note: A secure HTTP session is required. Therefore, all requests must be sent to https://. Sending a request to http:// will fail.
For example, if you want to retrieve a list of users from OMS you would use an HTTP GET method. The GET request would be sent to https://hostname/oms/api/users/.
REST sometimes is referred to as using QCRUD, where each letter stands for a different action that can be taken: Query, Create, Read, Update, Delete. The REST API is comprised of these HTTP actions:
GET: used to query for or read data from the server, like user IDs or dashboard results. GET is considered a “safe” method because no changes on the server are made.
POST: used to create new objects, like users, users, or dashboards. For a POST method, the HTTP response contains the URI path and {ID} of the newly created resource in the “Location” HTTP header. For example, when a new user is created, the “Location” HTTP header will contain: "/users/9D24469A-976E-11E4-B88F-002590365523".
PUT: used to update an existing object. All PUT methods must always take the full resource definition, not just fields being modified. A PUT request is considered Idempotent or “unsafe” because it can change an existing object. This is not to imply that PUT actions should not be done. Not at all. Instead, it means simply that you must ensure that the definition you send has exactly the values you want it to have before issuing the PUT.
DELETE: used to delete an object. A DELETE is also considered Idempotent. After an object has been deleted with the DELETE method, it cannot be restored. There is no confirmation requested like there is in the web interface. Use with care!
All time values are specified in UTC using the ISO8601 time format: "2015-10-24T04:06:16Z". The Z at the end of the format indicates that there is no time offset from UTC. UTC does not observe summer time (daylight savings time). It is also possible that UTC may be several hours different from your local time. The web UI client uses its local browser time, but all API requests use UTC.
{ID} denote a variable ID value in the endpoint where ID is a UUID of the form "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX". For example, /users/9D24469A-976E-11E4-B88F-002590365523.
If the word optional is not listed for a parameter, the parameter is required. Some strings are enumerated lists, and the string must be one of the listed items.