Public API for NMIS configuration. "omk/admin/api/v2/"
We can manage the below admin configurations using this API:- http://host/en/omk/admin/api/v2/
| API-OPTIONS:- | Locations | Contacts | Services | Escalations | Events | Polling-Policy | Users | Access | Customers | BusinessServices |
|---|
This API can help you to manage the below operations for the given admin configurations.
| Name | Operation | Method | URL | Response | Example | code-block |
|---|---|---|---|---|---|---|
| Locations | Create | POST | http://host/en/omk/admin/api/v2/locations.json | New Location in NMIS configurations. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations.json | {
"Address1": "",
"Address2": "",
"City": "",
"Country": "",
"Floor": "",
"Geocode": "fake geo code",
"Latitude": "xx.xxxxxxx",
"Location": "Mandatory param",
"Longitude": "xx.xxxxxxx",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": ""
}
|
| Locations | GET | GET | http://host/en/omk/admin/api/v2/locations.json | Locations present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations.json | |
| Locations | GET | GET | http://host/en/omk/admin/api/v2/locations{location-name}.json | Locations present in NMIS configuration file. | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Amsterdam.json | {
"Address1": "",
"Address2": "",
"City": "Amsterdam",
"Country": "Netherlands",
"Floor": "",
"Geocode": "Amsterdam, Netherlands",
"Latitude": "52.3675734",
"Location": "Amsterdam",
"Longitude": "4.9041389",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": "",
"_id": "Amsterdam"
}
|
| Locations | Update | PUT | http://host/en/omk/admin/api/v2/locations/{location-name}.json | Updated location entry | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json | {
"Address1": "",
"Address2": "",
"City": "",
"Country": "",
"Floor": "",
"Geocode": "fake geo code",
"Latitude": "xx.xxxxxxx",
"Location": "Mandatory param",
"Longitude": "yy.yyyyyyy",
"Postcode": "",
"Room": "",
"State": "",
"Suburb": ""
}
|
| Locations | Delete | DELETE | http://host/en/omk/admin/api/v2/locations/{location-name}.json | Deletes the location entry from configurations | http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json | I like cheese! { |
Important: All this methods are authenticated.
Operation | Method | URL | Example |
|---|---|---|---|
| Authenticate | POST | http://host/en/omk/admin/login | {"username": "username", "password": "password"}
|
We should receive a 200 response and a cookie, that we can reuse for next API calls.