Versions Compared

Key

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

...

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

...


...



Locations present configuration file{ Amsterdam Netherlands " Amsterdam, Netherlands 523675734 Amsterdam 49041389 , "_id": "Amsterdam" {        .json                                   fake geo code       xxxxxxxxx       Mandatory param       yyyyyyyyy                               { "Description": "Dummy Entry for API", "Name": "dummy", "Poll_Interval": "5m", "PortService_Namedummy.exe "Service_Type" new_typeServicesGETGET/servicesServices present in NMIS configuration file.serviceshttp://{ "Description": "Dummy Entry for API

.json

Anchor
locations
locations
Name

OperationMethodURLResponseExample

Locations

CreatePOSThttp://host/en/omk/admin/api/v2/locations.json

new Location in NMIS

configurations.

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
Code Block
{
        "Address1": "",
        
"Address2": "",
        
"City": "
",
        
"Country": "
",
        
"Floor": "",
        
"Geocode": "
fake geo code",
        
"Latitude": "
xx.
xxxxxxx",
        
"Location": "
Mandatory param",
        
"Longitude": "
xx.
xxxxxxx",
        
"Postcode": "",
        "Room": "",
        
"State": "",
        
"Suburb": ""

 
   }


LocationsUpdateGETPUTGEThttp://host/en/omk/admin/api/v2/locations/{location-name}.jsonUpdate location entryLocations present in NMIS configuration file.http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json
Code Block
themeFadeToGrey
LocationsGETGEThttp://host/en/omk/admin/api/v2/locations{location-name}.jsonLocations present in NMIS configuration file.
  "Address2": "",
    "City": "Amsterdam",
 
   "Country": "Netherlands",
   
 "Floor": "",
   
 "Geocode": "
Amsterdam, Netherlands",
   
 "Latitude": "
52.
3675734",
    "Location": "
Amsterdam",
    "Longitude": "
4.
9041389",
    "Postcode": "",
    "Room": "",
    "State": "",
 
   "Suburb": "",
    "_id": 
"Amsterdam"
}


LocationsDeleteUpdateDELETEPUThttp://host/en/omk/admin/api/v2/locations/{location-name}.jsonDeletes the Update location entry from configurations

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

Code Block
themeFadeToGrey
 {
        "Address1": "",
        "Address2": "redirect_to",
        "City": null"",
        "Country": "",
        "successFloor": "",
1
}
Anchor
servicesservices

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
        "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 configurationsServicesGETGET
Code Block
{
    "redirect_to": null,
    "success": 1
}


Anchor
services
services

Services

Create

POSThttp://host/en/omk/admin/api/v2/services/{service-name}.jsonServices present new services in NMIS configuration fileconfigurations./dummy.json
Code Block
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.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
{
    "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 entry

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

Anchor
contacts
contacts

Contacts

Create

POSThttp://host/en/omk/admin/api/v2/contacts.jsonCreate a new contact

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

Code Block
{
    "Contact": "Test-Contact",
    "DutyTime": "",
    "Email": "",
    "Level": "",
    "Location": "",
    "Mobile": "",
    "Pager": "",
    "Phone": "",
    "TimeZone": ""
}


ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts.jsonget contact information present in configurationhttp://host/en/omk/admin/api/v2/contacts.jsonContactsGETGEThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonget specific contact information using API

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

Code Block
{
    "Contact": "Test-Contact",
    "DutyTime": "",
    "Email": "",
    "Level": "",
    "Location": "",
    "Mobile": "",
    "Pager": "",
    "Phone": "",
    "TimeZone": "",
    "_id": "Test-Contact"
}


ContactsUpdatePUThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonUpdate the contact data present in configuration file

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

Code Block
{
    "Contact": "Test-Contact",
    "DutyTime": "1",
    "Email": "test@gmail.com",
    "Level": "",
    "Location": "",
    "Mobile": "",
    "Pager": "",
    "Phone": "",
    "TimeZone": ""
}


ContactsDeleteDELETEhttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsondelete the contact data.

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


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": "dummytest",
    "Poll_IntervalRole": null,
    "5mType": null,
     "Port": "",
    "Service_Name": "dummy.exe","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
{
    "Serviceredirect_Typeto": "new_type"null,
    "_idsuccess": "dummy"1
}
ServicesUpdate


PUT

Anchor
events
events

Events

Create

POSThttp://host/en/omk/admin/api/v2/services/{service-name}/events.jsonUpdate Services entry
services/dumy

events.json

Code Block
themeFadeToGrey
{
        "CancelingEvent": "N/A",
        "Description": "Dummytest Entryevent for API",
        "NameEvent": "dummy_updatedSelf-test-API",
        "Poll_IntervalLog": "10mtrue",
        "PortNotify": "true",
        "Service_NameStateful": "dummy.exefalse",
        "Service_TypeStatus" : "new_typefalse"
    }


ServicesEventsDeleteGETDELETEGEThttp://host/en/omk/admin/api/v2/services/{service-name}events.jsonDeletes 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/events.jsonEventsGETGEThttp://host/en/omk/admin/api/v2/contacts/events/{event-name}.jsonCreate a new contact
contacts

events/Self-test-API.json

Code Block
{
    "Contact    "CancelingEvent": "Test-Contact "N/A",
    "DutyTime    "Description": "",
    "Email": "",
    "Level": " "test event API",
    "Location    "Event":  "Self-test-API",
    "Mobile    "Log":  "true",
    "Pager    "Notify":  "true",
    "Phone    "Stateful":  "false",
    "TimeZone    "Status":  "false"
}
ContactsGETGEThttp://host/en/omk/admin/api/v2/contacts.jsonget contact information present in configurationhttp://host/en/omk/admin/api/v2/contacts.jsonContactsGETGET
,
    "_id": "Self-test-API"
}


EventsUpdatePUThttp://host/en/omk/admin/api/v2/contactsevents/{contactevent-name}.jsonget specific contact information using API
contactsTestContact

API.json

Code Block
{
    "Contact        "Description":  "Test-Contacttest event API",
    "DutyTime        "Event":  "test",
    "Email        "Log":  "true-change",
    "Level        "Notify":  "true",
    "Location        "Stateful":  "false",
    "Mobile        "Status":  "false",
    "Pager": "",
    "Phone": "",
    "TimeZone": ""
    }


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,
    "_idsuccess": "Test-Contact"1
}
ContactsUpdatePUT


Anchor
polling-policy
polling-policy

Polling-PolicyCreatePOSThttp://host/en/omk/admin/api/v2/contacts/{contactpolling-name}policy.jsonUpdate the contact data present in configuration file
contacts/TestContact

policy.json

Code Block
{  {
  "Contact": "Test-Contact",     "DutyTimedescription": "1poll very infr_very.equently",
        "Emailname": "test@gmail.comvery_very_infrequently",
        "Levelping": "30m",
    "Location": "",     "Mobilesnmp": "1h",
 
  "Pager": "",     "Phoneupdate": "2d",
        "TimeZonewmi": "1h"
    }


ContactsPolling-PolicyDeleteGETDELETEGEThttp://host/en/omk/admin/api/v2/contacts/{contact-name}polling-policy.jsondelete the contact data.
escalations

Escalations

Create

POSThttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json
Code Block
{
    "redirect_to": null,
    "success": 1
}
Anchorescalations:8080/en/omk/admin/api/v2/polling-policy.jsonPolling-PolicyGETGEThttp://host/en/omk/admin/api/v2/escalations/polling-policy/{policy name}.json
escalations.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
}
EscalationsGETGEThttp://host/en/omk/admin/api/v2/escalations.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.jsonGETGET

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/polling-policy/{policy name}.json

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policy/very_very_infrequently.json

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


Polling-PolicyDeleteDELETEhttp://host/en/omk/admin/api/v2/escalationspolling-policy/{escalation-eventpolicy name}.json
escalations/test

polling-policy/very_very_infrequently.json

Code Block
{
    "Event": null,
    "Event_Element": "",
    "Event_Node": "",
    "Group": "",
    "Level0": ""redirect_to": null,
    "Level1success": "",
    "Level101
}


Anchor
users
users

UsersCreatePOSThttp://host/en/omk/admin/api/v2/users.json

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

Code Block
{
    "admission": "true",
  
     "Level2groups": "all",
    "Level3    "privilege": "administrator",
    "Level4": "",
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null,
    "_id": "test"
}
Escalations
    "user": "johnsmith"
}


UsersGETGEThttp://host/en/omk/admin/api/v2/users.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users.jsonUsersGETGEThttp://host/en/omk/admin/api/v2/users/{user:name}.json

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/johnsmith.json

Code Block
{
    "_id": "johnsmith",
    "admission": "true",
    "groups": [
        "all"
    ],
    "privilege": "administrator",
    "user": "johnsmith"
}


UsersUpdatePUThttp://host/en/omk/admin/api/v2/escalationsusers/{escalation-eventuser:name}.json
escalationstest

johnsmith.json

Code Block
{
    "Event    "admission": "testfalse",
    "Event_Element    "groups": "",
    "Event_Node": "",
    "Group": "",
    "Level0": "",
    "Level1": "",
    "Level10[
        "all"
    ],
    "privilege": "administrator",
    "Level2    "user": "",johnsmith"
}


UsersDeleteDELETEhttp://host/en/omk/admin/api/v2/users/{user:name}.json

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/users/johnsmith.json

Code Block
{
    "Level3redirect_to": ""null,
    "Level4success": "",
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null
}
EscalationsDeleteDELETE
1
}


Anchor
access
access

AccessCreatePOSThttp://host/en/omk/admin/api/v2/access.json

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

Code Block
{
    "descr": "Enable button Logs",
    "group": "button",
    "level0": "1",
    "level1": "0",
    "level2": "0",
    "level3": "0",
    "level4": "0",
    "level5": "0",
    "name": "test_logs"
}


AccessGETGEThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}access.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/testaccess.json
Code Block
{
    "redirect_to": null,
    "success": 1
}
Anchoreventsevents

Events

Create

POSTAccessGETGEThttp://host/en/omk/admin/api/v2/eventsaccess/{access-id}.json
eventsEventsGETGEThttp://host/en/omk/admin/api/v2/events.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.jsonEventsGETGET {
        "CancelingEvent": "N/A",
        "Description": "test event API",
        "Event": "Self-test-API",
        "Log": "true",
        "Notify": "true",
        "Stateful": "false",
        "Status": "false"
    }
Code Block
{
    "_id": "test_logs",
    "descr": "Enable button Logs",
    "group": "button",
    "level0": "1",
    "level1": "0",
    "level2": "0",
    "level3": "0",
    "level4": "0",
    "level5": "0",
    "name": "test_logs"
}


AccessUpdatePUThttp://host/en/omk/admin/api/v2/eventsaccess/{eventaccess-nameid}.json
eventsSelf--API{
    "CancelingEvent
Code Block
{
    "_id": "test_logs",
    "descr": "Enable button Logs",
    "group""
N/A
button new",


    "
Description
level0""
test event API
1",


    "
Event
level1""
Self-test-API
0",


    "
Log
level2""
true
0",


    "
Notify
level3""
true
0",


    "
Stateful
level4""
false
0",


    "
Status
level5""
false
0",


    "
_id
name""
Self-
test
-API
_logs"


}


EventsAccessUpdateDeletePUTDELETEhttp://host/en/omk/admin/api/v2/eventsaccess/{eventaccess-nameid}.json
eventsSelf-test-API.jsonEventsDeleteDELETE

test_logs.json

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


Anchor
customers
customers

CustomersCreatePOSThttp://host/en/omk/admin/api/v2/events/{event-name}customers.json
events/Self-test-API

customers.json

Code Block
  {
        "customer": "test",
   "redirect_to": null,
    "success": 1
}
Anchorpolling-policypolling-policyPolling-PolicyCreatePOST
        "description": "",
        "groups": "",
        "locations": null
    }


CustomersGETGEThttp://host/en/omk/admin/api/v2/polling-policycustomers.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/polling-policycustomers.jsonPolling-PolicyCustomersGETGEThttp://host/en/omk/admin/api/v2/polling-policycustomers/{customer-name}.json
/v2/polling-policy.jsonPolling-PolicyGETGET

/v2/customers/test.json

Code Block
{
    "_id": "test",
    "customer": "test",
    "description": "",
    "groups": "",
    "locations": null
}


CustomersUpdatePUThttp://host/en/omk/admin/api/v2/polling-policycustomers/{policy customer-name}.json
polling-policy/very_very_infrequently

customers/test.json

Code Block
{
    "_id": "very_very_infrequently",
    "description": "poll very infr_very.equently",
    "name": "very_very_infrequently",
    "ping  {
        "customer": "30mtest",
            "snmpdescription": "1hthis is test",
            "updategroups": "2d",
            "wmilocations": "1h" null
    }


Polling-PolicyCustomersUpdateDeletePUTDELETEhttp://host/en/omk/admin/api/v2/polling-policycustomers/{policy customer-name}.json
polling-policy/very_very_infrequentlyDELETE

customers/test.json

Code Block
{   
	"description": "poll",
    "name": "very_very_infrequently",
    "ping": "30m",
    "snmp": "1h",
    "update": "2d",
    "wmi": "1h"
}
 
Polling-PolicyDelete

    "redirect_to": null,
    "success": 1
}


Anchor
business
business

Business ServicesCreatePOSThttp://host/en/omk/admin/api/v2/polling-policy/{policy name}businessservices.json
polling-policy/very_very_infrequently

businessservices.json

Code Block
{
        "businessPriority": "10",
   "redirect_to": null,
    "success": 1
}
AnchorusersusersUsersCreatePOSTUsersGETGETUsersGETGETUsersUpdatePUTUsersDeleteDELETE AnchoraccessaccessAccessCreatePOSTAccessGETGETAccessGETGETAccessUpdatePUTAccessDeleteDELETE AnchorcustomerscustomersCustomersCreatePOSTCustomersGETGETCustomersGETGETCustomersUpdatePUTCustomersDeleteDELETE AnchorbusinessbusinessBusiness ServicesCreatePOSTBusiness ServicesGETGETBusiness ServicesGETGETBusiness ServicesUpdatePUTBusiness ServicesDeleteDELETE
        "businessService": "test",
        "businessUnit": "Sales",
        "serviceType": "Revenue Generating"
    }


Business ServicesGETGEThttp://host/en/omk/admin/api/v2/businessservices.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices.jsonBusiness ServicesGETGEThttp://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/businessservices/test.json

Code Block
{
    "_id": "test",
    "businessPriority": "10",
    "businessService": "test",
    "businessUnit": "Sales",
    "serviceType": "Revenue Generating"
}


Business ServicesUpdatePUThttp://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json
Code Block
{
        "businessPriority": "11",
        "businessService": "test",
        "businessUnit": "Sales",
        "serviceType": "Revenue Generating"
    }


Business ServicesDeleteDELETEhttp://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json