Page Comparison

...

code-block

...

Locations

...

API OPTIONS	Locations	Services	Contacts	Escalations	Events	Polling-Policy	Users	Access	Customers	BusinessServices

locations

Anchor

	locations
	locations

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

Code Block

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

Locations

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

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

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"
}

Locations

Update

PUT

http://host/en/omk/admin/api/v2/locations/{location-name}.json

Update location entry

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json

Code Block

theme	FadeToGrey

 {
        "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

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

Anchor

	services
	services

Services

Create

POST

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

new 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" }

Services

GET

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

Services

GET

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

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.jsonLocationsGETGET

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

theme	FadeToGrey

{
    "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/locations{locationservice-name}.jsonLocations present in NMIS configuration file.Deletes the Service entry from configurationshttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/locationsservices/Amsterdamdummy_updated.json Code Block{ "Address1": "", "Address2": "",

Code Block
{ "Cityredirect_to": "Amsterdam"null, "Countrysuccess": "Netherlands", "Floor": "", 1 }

Anchor

	contacts
	contacts

Contacts

Create

POSThttp://host/en/omk/admin/api/v2/contacts.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts.json

Code Block

{
    "GeocodeContact": "Amsterdam, NetherlandsTest-Contact",
    "LatitudeDutyTime": "52.3675734",
    "LocationEmail": "Amsterdam",
    "LongitudeLevel": "4.9041389",
    "PostcodeLocation": "",
    "RoomMobile": "",
    "StatePager": "",
    "SuburbPhone": "",
    "_idTimeZone": "Amsterdam"
}

LocationsUpdatePUT

"
}

ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts.json
http://host/en/omk/admin/api/v2/contacts.json
ContactsGETGEThttp://host/en/omk/admin/api/v2/locationscontacts/{locationcontact-name}.jsonUpdate location entry
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory paramcontacts/Test-Contact.json

Code Block

theme	FadeToGrey

"Address1": "",

"Address2": "", "City": "",

Country

Contact": "Test-Contact",

Floor

DutyTime": "",

Geocode

Email": ""

fake

geo

code",

Latitude

Level": "

xx.xxxxxxx

",

 "Location": "

Mandatory param

",

Longitude

Mobile": "

yy.yyyyyyy

",

Postcode

Pager": "",

Room

Phone": "",

State

TimeZone": "",

Suburb

_id": "Test-Contact"

LocationsContactsDeleteUpdateDELETEPUThttp://host/en/omk/admin/api/v2/locationscontacts/{locationcontact-name}.jsonDeletes the location entry from configurations
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory paramcontacts/Test-Contact.json

Code Block

{


{ "Contact": "Test-Contact", "

redirect_to

DutyTime":

null

"1",
    "

success

Email":

1 } Anchorservicesservices

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
{ "test@gmail.com", "Level": "", "Location": "", "Mobile": "", "DescriptionPager": "Dummy Entry for API", "NamePhone": "dummy", "Poll_IntervalTimeZone": "5m", "Port": ""," }

ContactsDeleteDELETEhttp://host/en/omk/admin/api/v2/contacts/{contact-name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json

Code Block
{ "Serviceredirect_Nameto": "dummy.exe"null, "Service_Typesuccess" : "new_type"1 }

ServicesGETGET

Anchor

	escalations
	escalations

Escalations

Create

POSThttp://host/en/omk/admin/api/v2/servicesescalations.json

Services present in NMIS configuration file.

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services.jsonServicesGETGEThttp://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{/escalations.json

Code Block

{
    "Event": null,
    "Event_Element": "",
    "Event_Node": "",
    "Group": "",
    "DescriptionLevel0": ""Dummy,
   Entry for API"Level1": "",
    "NameLevel10": "dummy",
    "Poll_IntervalLevel2": "5m",
    "PortLevel3": "",
    "Service_NameLevel4": "dummy.exe",
    "Service_TypeLevel5": "new_type",
    "_idLevel6": "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

theme	FadeToGrey

{,
    "Level7": "",
    "Level8": "",
    "DescriptionLevel9": "Dummy Entry for API",
    "Name": "dummy_updatedtest",
    "Poll_IntervalRole": "10m"null,
    "PortType": ""null,
    "Service_Name": "dummy.exe",
    "Service_Type" : "new_type"
}

ServicesDeleteDELETE

"UpNotify": null
}

EscalationsGETGEThttp://host/en/omk/admin/api/v2/escalations.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json

GETGEThttp://host/en/omk/admin/api/v2/services escalations/{serviceescalation-nameevent}.jsonDeletes the Service entry from configurations
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updated.json Code Block{escalations/test.json

Code Block
{ "Event": null, "Event_Element": "", "Event_Node": "", "redirect_toGroup": null"", "successLevel0": 1 }

Anchorcontactscontacts

Contacts

Create

POSThttp://host/en/omk/admin/api/v2/contacts/.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts.json

Code Block

{ "",
    "Level1": "",
    "Level10": "",
    "Level2": "",
    "Level3": "",
    "ContactLevel4": "Test-Contact",
    "DutyTimeLevel5": "",
    "EmailLevel6": "",
    "LevelLevel7": "",
    "LocationLevel8": "",
    "MobileLevel9": "",
    "PagerName": "test",
    "Phone": """Role": null,
    "Type": null,
    "UpNotify": null,
    "TimeZone_id": "test"
}

ContactsEscalationsGETUpdateGETPUThttp://host/en/omk/admin/api/v2/contacts/.json http://host/en/omk/admin/api/v2/contacts.jsonContactsGETGEThttp://host/en/omk/admin/api/v2/contacts/{contact-nameescalations/{escalation-event}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contactsescalations/Test-Contacttest.json

Code Block

{
    "ContactEvent": "Test-Contacttest",
    "DutyTimeEvent_Element": "",
    "EmailEvent_Node": "",
    "LevelGroup": "",
    "LocationLevel0": "",
    "MobileLevel1": "",
    "PagerLevel10": "",
    "Phone": "",
    "TimeZone": "",
    "_idLevel2": "Test-Contact"
}

ContactsUpdatePUThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json

Code Block

{",
    "Level3": "",
    "ContactLevel4": "Test-Contact",
    "DutyTimeLevel5": "1",
    "EmailLevel6": "test@gmail.com",
    "LevelLevel7": "",
    "LocationLevel8": "",
    "MobileLevel9": "",
    "PagerName": ""test",
    "Role": null,
    "PhoneType": ""null,
    "TimeZoneUpNotify": ""null
}

ContactsEscalationsDeleteDELETEhttp://host/en/omk/admin/api/v2/contactsescalations/{contactescalation-nameevent}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contactsescalations/Test-Contacttest.json

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

Anchorescalationsescalations

Escalations

Create

POSTEscalationsGETGETGETGETEscalationsUpdatePUTEscalationsDeleteDELETE


    "success": 1
}

Anchor

	events
	events

Events

Create

POST

EventsGETGET

EventsGETGET

EventsUpdatePUT

EventsDeleteDELETE

Anchor

	polling-policy
	polling-policy

Polling-PolicyCreatePOST

Polling-PolicyGETGET

Polling-PolicyGETGET

Polling-PolicyUpdatePUT

Polling-PolicyDeleteDELETE

Anchor

	users
	usersusers

UsersCreatePOST

UsersGETGET

UsersGETGET

UsersCreateUpdatePOSTPUT

UsersUsersDeleteUsersUsersDELETE

Anchor

	access
	access

AccessCreatePOST

AccessGETGET

AccessGETGET

AccessUpdatePUT

AccessDeleteDELETE

Anchor

	customers
	customers

CustomersCreatePOST

CustomersGETGET

CustomersGETGET

CustomersUpdatePUT

CustomersDeleteDELETE

Anchor

	business
	business

Business ServicesCreatePOST

Business ServicesGETGET

Business ServicesGETGET

Business ServicesUpdatePUT

Business ServicesDeleteDELETE

Versions Compared

Old Version 20

New Version 21

Key