Page Comparison

...

code-block

...

Locations

...

new Location in NMIS configurations.

...

Code Block

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

...

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

...

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

...

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

/{location-name}Deletes the location entry from configurations/Mandatory param "redirect_tonullsuccess1 }{ "DescriptionDummyEntryfor API Namedummy "Poll_Interval5mPortService_Namedummy.exe Service_Type new_typeServicesservicesServices servicesservicesservice Services servicesdumy DescriptionDummy Entry for API Namedummy_updated Poll_Interval10m Port "Service_Namedummy.exe "Service_Type" new_type" }

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": "",

Anchor

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

        "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

ServicesLocations

GET

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

Services Locations present in NMIS configuration file.

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/serviceslocations/dummyAmsterdam.json

Code Block

{
    "DescriptionAddress1": "Dummy Entry for API",
    "Address2": "",
    "City": "Amsterdam",
    "NameCountry": "dummyNetherlands",
    "Poll_IntervalFloor": "5m",
    "PortGeocode": "Amsterdam, Netherlands",
    "Service_NameLatitude": "dummy52.exe3675734",
    "Service_TypeLocation": "new_typeAmsterdam",
    "_idLongitude": "dummy4.9041389"
}

Services

,
    "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": "

Services

Delete

DELETE

http://host/en/omk/admin/api/v2/services/{service-name}.json

Deletes the Service entry from configurations

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

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

Anchorcontactscontacts

Contacts

Create

POST

fake geo code",
        "Latitude": "xx.xxxxxxx",
        "Location": "Mandatory param",
        "Longitude": "yy.yyyyyyy",
        "Postcode": "",
        "Room": "",
        "State": "",
        "Suburb": ""
    }

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

Code Block
{ "

Contact

redirect_to":

"Test-Contact"

null,
    "

DutyTime

success":

"", "Email": "",

1
}

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
{ "LevelDescription": "Dummy Entry for API", "LocationName": "dummy", "MobilePoll_Interval": "5m", "PagerPort": "", "PhoneService_Name": "dummy.exe", "TimeZoneService_Type" : "new_type" }

ContactsServicesGETGEThttp://host/en/omk/admin/api/v2/contactsservices.json

Services present in NMIS configuration file.

http://hostapollo.opmantek.net:8080/en/omk/admin/api/v2/contactsservices.json
ContactsServicesGETGEThttp://host/en/omk/admin/api/v2/contactsservices/{contactservice-name}.json

Services present in NMIS configuration file.

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/contactsservices/Test-Contactdummy.json

Code Block

{
    "ContactDescription": "Test-Contact",Dummy Entry    "DutyTime": "for API",
    "EmailName": "dummy",
    "LevelPoll_Interval": "5m",
    "LocationPort": "",
    "MobileService_Name": "dummy.exe",
    "PagerService_Type": "new_type",
    "Phone": "",
    "TimeZone": "",
    "_id": "Test-Contactdummy"
}

ContactsServicesUpdatePUThttp://host/en/omk/admin/api/v2/contactsservices/{contactservice-name}.jsonUpdate Services entryhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contactsservices/Test-Contactdumy.json

Code Block

theme	FadeToGrey

{
    "ContactDescription": "Test-Contact",Dummy Entry for   "DutyTime": "1"API",
    "EmailName": "test@gmail.comdummy_updated",
    "LevelPoll_Interval": "10m",
    "LocationPort": "",
    "MobileService_Name": "dummy.exe",
    "PagerService_Type" : "new_type",
    "Phone": "",
    "TimeZone": ""
}

Contacts

ServicesDeleteDELETEhttp://host/en/omk/admin/api/v2/contactsservices/{contactservice-name}.jsonDeletes the Service entry from configurationshttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contactservices/dummy_updated.json

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

Anchor

escalations

	contacts

escalations

	contacts

EscalationsContacts

Create

POSThttp://host/en/omk/admin/api/v2/escalations contacts.jsonCreate a new contacthttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalationscontacts.json

Code Block

{
    "EventContact": null"Test-Contact",
    "DutyTime"Event_Element": "",
    "Event_NodeEmail": "",
    "GroupLevel": "",
    "Level0Location": "",
    "Level1Mobile": "",
    "Level10Pager": "",
    "Level2Phone": "",
    "Level3TimeZone": "",
    "Level4": "",
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "
}

ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts.jsonget contact information present in configurationhttp://host/en/omk/admin/api/v2/contacts.json
ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonget specific contact information using APIhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json

Code Block
{ "Contact": "Test-Contact", "Level9DutyTime": "", "NameEmail": "test", "RoleLevel": null"", "TypeLocation": null"", "UpNotifyMobile": "", null }

EscalationsGETGEThttp://host/en/omk/admin/api/v2/escalations.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.jsonGETGET

 "Pager": "",
    "Phone": "",
    "TimeZone": "",
    "_id": "Test-Contact"
}

ContactsUpdatePUThttp://host/en/omk/admin/api/v2/escalations contacts/{escalationcontact-eventname}.jsonUpdate the contact data present in configuration filehttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalationscontacts/testTest-Contact.json

Code Block

{
    "EventContact": null,
    "Event_Element": """Test-Contact",
    "Event_NodeDutyTime": "1",
    "GroupEmail": "test@gmail.com",
    "Level0Level": "",
    "Level1Location": "",
    "Level10Mobile": "",
    "Level2Pager": "",
    "Level3Phone": "",
    "Level4TimeZone": "",
    "Level5": "",

}

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

Code Block
{ "Level6redirect_to": ""null, "Level7success": "", 1 }

Anchor

	escalations
	escalations

Escalations

Create

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

Code Block
{ "Level8Event": ""null, "Level9Event_Element": "", "Event_Node": "", "NameGroup": "test", "RoleLevel0": null"", "TypeLevel1": null"", "UpNotifyLevel10": null"", "_idLevel2": "test" }

EscalationsUpdatePUThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json

Code Block

{,
    "Level3": "",
    "EventLevel4": "test",
    "Event_ElementLevel5": "",
    "Event_NodeLevel6": "",
    "GroupLevel7": "",
    "Level0Level8": "",
    "Level1Level9": "",
    "Level10Name": "test",
    "Level2Role": ""null,
    "Level3Type": ""null,
    "Level4UpNotify": "",
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null
}

EscalationsDeleteDELETE

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

Code Block

{
    "Event": null,
    "Event_Element": "",
    "Event_Node": "",
    "Group": "",
    "Level0": "",
    "Level1": "",
    "Level10": "",
    "Level2": "",
    "Level3": "",
    "Level4": "",
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null,
    "_id": "test"
}

EscalationsUpdatePUThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json

Code Block

{
    "Event": "test",
    "Event_Element": "",
    "Event_Node": "",
    "Group": "",
    "Level0": "",
    "Level1": "",
    "Level10": "",
    "Level2": "",
    "Level3": "",
    "Level4": "",
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null
}

EscalationsDeleteDELETEhttp://host/en/omk/admin/api/v2/escalations/{escalation-event}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json

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

Anchor

	events
	events

Events

Create

POSThttp://host/en/omk/admin/api/v2/events.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json {
"CancelingEvent": "N/A",
"Description": "test event API",
"Event": "Self-test-API",
"Log": "true",
"Notify": "true",
"Stateful": "false",
"Status": "false"
}EventsGETGEThttp://host/en/omk/admin/api/v2/events.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json
EventsGETGEThttp://host/en/omk/admin/api/v2/events/{event-name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.json

{
    "CancelingEvent": "N/A",
    "Description": "test event API",
    "Event": "Self-test-API",
    "Log": "true",
    "Notify": "true",
    "Stateful": "false",
    "Status": "false",
    "_id": "Self-test-API"
}

EventsUpdatePUThttp://host/en/omk/admin/api/v2/events/{event-name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.json
EventsDeleteDELETEhttp://host/en/omk/admin/api/v2/events/{event-name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.json

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

Anchor

	polling-policy
	polling-policy

Polling-PolicyCreatePOSThttp://host/en/omk/admin/api/v2/polling-policy.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json
Polling-PolicyGETGEThttp://host/en/omk/admin/api/v2/polling-policy.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy.json
Polling-PolicyGETGEThttp://host/en/omk/admin/api/v2/polling-policy/{policy name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequently.json

Code Block
{ "_id": "very_very_infrequently", "description": "poll very infr_very.equently", "name": "very_very_infrequently", "ping": "30m", "snmp": "1h", "update": "2d", "wmi": "1h" }

Polling-PolicyUpdatePUThttp://host/en/omk/admin/api/v2/escalations polling-policy/{escalation-eventpolicy name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/testpolling-policy/very_very_infrequently.json

Code Block
{ "description": "poll", "name": "very_very_infrequently", "ping": "30m", "redirect_to": null, "success": 1 }

Anchoreventsevents

Events

Create

POSTEventsGETGETEventsGETGETEventsUpdatePUTEventsDeleteDELETE Anchorpolling-policypolling-policyPolling-PolicyCreatePOSTPolling-PolicyGETGETPolling-PolicyGETGETPolling-PolicyUpdatePUTPolling-PolicyDeleteDELETE

    "snmp": "1h",
    "update": "2d",
    "wmi": "1h"
}

Polling-PolicyDeleteDELETEhttp://host/en/omk/admin/api/v2/polling-policy/{policy name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequently.json

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

Anchor

	users
	users

UsersCreatePOST

UsersGETGET

UsersGETGET

UsersUpdatePUT

UsersDeleteDELETE

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 22

New Version 23

Key