Versions Compared

Old Version 4

changes.mady.by.user Arihant Bansal

Saved on

compared with

New Version 5

changes.mady.by.user Arihant Bansal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


API-OPTIONSLocationsServicesContactsEscalationsEventsPolling-PolicyUsersAccessCustomersBusinessServices

...

NameOperationMethodURLResponseExample

 code-block

Locations

Anchor
locations
locations

CreatePOSThttp://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


Code Block
{
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "Floor": "",
        "Geocode": "fake geo code",
        "Latitude": "xx.xxxxxxx",
        "Location": "Mandatory param",
        "Longitude": "xx.xxxxxxx",
        "Postcode": "",
        "Room": "",
        "State": "",
        "Suburb": ""
    }


LocationsGETGEThttp://host/en/omk/admin/api/v2/locations.jsonLocations present in NMIS configuration file.http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations.json



LocationsGETGEThttp://host/en/omk/admin/api/v2/locations{location-name}.jsonLocations present in NMIS configuration file.http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Amsterdam.json


Code Block
{
    "Address1": "",
    "Address2": "",
    "City": "Amsterdam",
    "Country": "Netherlands",
    "Floor": "",
    "Geocode": "Amsterdam, Netherlands",
    "Latitude": "52.3675734",
    "Location": "Amsterdam",
    "Longitude": "4.9041389",
    "Postcode": "",
    "Room": "",
    "State": "",
    "Suburb": "",
    "_id": "Amsterdam"
}


LocationsUpdatePUThttp://host/en/omk/admin/api/v2/locations/{location-name}.jsonUpdate location entryhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json


Code Block
themeFadeToGrey
 {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "Floor": "",
        "Geocode": "fake geo code",
        "Latitude": "xx.xxxxxxx",
        "Location": "Mandatory param",
        "Longitude": "yy.yyyyyyy",
        "Postcode": "",
        "Room": "",
        "State": "",
        "Suburb": ""
    }


LocationsDeleteDELETEhttp://host/en/omk/admin/api/v2/locations/{location-name}.jsonDeletes the location entry from configurationshttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json


Code Block
{
    "redirect_to": null,
    "success": 1
}


NameOperationMethodURLResponseExample

 code-block

Anchor
services
services

Services

Create

POSThttp://host/en/omk/admin/api/v2/services.jsonnew services in NMIS configurations.http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services.json


Code Block
{
    "Description": "Dummy Entry for API",
    "Name": "dummy",
    "Poll_Interval": "5m",
    "Port": "",
    "Service_Name": "dummy.exe",
    "Service_Type" : "new_type"
}


ServicesGETGEThttp://host/en/omk/admin/api/v2/services.json

Services present in NMIS configuration file.

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services.json
ServicesGETGEThttp://host/en/omk/admin/api/v2/services/{service-name}.json

Services present in NMIS configuration file.

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy.json


Code Block
{
    "Description": "Dummy Entry for API",
    "Name": "dummy",
    "Poll_Interval": "5m",
    "Port": "",
    "Service_Name": "dummy.exe",
    "Service_Type": "new_type",
    "_id": "dummy"
}


ServicesUpdatePUThttp://host/en/omk/admin/api/v2/services/{service-name}.jsonUpdate Services entryhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dumy.json


Code Block
themeFadeToGrey
{
    "Description": "Dummy Entry for API",
    "Name": "dummy_updated",
    "Poll_Interval": "10m",
    "Port": "",
    "Service_Name": "dummy.exe",
    "Service_Type" : "new_type"
}


ServicesDeleteDELETEhttp://host/en/omk/admin/api/v2/services/{service-name}.jsonDeletes the Service entry from configurationshttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updated.json


Code Block
{
    "redirect_to": null,
    "success": 1
}


NameOperationMethodURLResponseExample

 code-block

Contacts

Create

POST



ContactsGETGET



ContactsUpdatePUT



ContactsDeleteDELETE



NameOperationMethodURLResponseExample

 code-block

Escalations

Create

POST



EscalationsGETGET



EscalationsUpdatePUT



EscalationsDeleteDELETE



NameOperationMethodURLResponseExample

 code-block

Events

Create

POST



EventsGETGET



EventsUpdatePUT



EventsDeleteDELETE



...