Versions Compared

Key

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

...

Locations

...


...

 code-block



/locationsnew Location in NMIS configurations.locationsGET/locationsLocations present in NMIS configuration file.locationsPUTlocationslocationUpdate location entrylocations/Mandatory param         "Address1": "",         "Address2": "",         "City": "",         "Country": "",         "Floor": "",         "Geocode":"fakegeocode",       Latitudexx.xxxxxxx       LocationMandatory param       Longitudeyy.yyyyyyy       Postcode       "Room":"",       State       "Suburb":""    }{redirect_tonullsuccess1anchorPolling-Policy { "description": "poll very infr_very.equently", "name": "very_very_infrequently", "ping

/users.json

Anchor
locations
locations
Name

OperationMethodURLResponseExample

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 entry

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

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


Anchor
contacts
contacts

Contacts

Create

POSThttp://host/en/omk/admin/api/v2/locations{location-name}v2/contacts.jsonLocations present in NMIS configuration file.Create a new contactlocations/Amsterdam

contacts.json

Code Block
{
    "Address1": "",
    "Address2": "",
    "City": "Amsterdam",
    "Country": "Netherlands",
    "Floor": "",
    "GeocodeContact": "Amsterdam, NetherlandsTest-Contact",
    "LatitudeDutyTime": "52.3675734",
    "LocationEmail": "Amsterdam",
    "LongitudeLevel": "4.9041389",
    "PostcodeLocation": "",
    "RoomMobile": "",
    "StatePager": "",
    "SuburbPhone": "",
    "_idTimeZone": "Amsterdam"
}
LocationsUpdate


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 API
themeFadeToGrey
{

 
 
 
 "
Contact": "
Test-Contact",
    "
DutyTime": "
",
  
  "
Email": "
",
   
 "
Level": "",
 
 
 
 "
Location": "",
 
 
 
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
 "Mobile": "",
    "Pager": "",
    "Phone": "",
    "
TimeZone": 
"",
    "
_id": 
"Test-Contact"
}


Contactsservicesservices

Services

Create

POSTUpdatePUThttp://host/en/omk/admin/api/v2/servicescontacts/{contact-name}.jsonnew services in NMIS configurations.Update the contact data present in configuration fileservices

Test-Contact.json

Code Block
{
    "DescriptionContact": "Test-Contact",
    "DutyTime": "1",
    "Email": "Dummy Entry for APItest@gmail.com",
    "Level": "",
    "NameLocation": "dummy",
    "Poll_IntervalMobile": "5m",
    "PortPager": "",
    "Service_NamePhone": "dummy.exe",
    "Service_TypeTimeZone" : "new_type"
}


ServicesContactsGETDeleteGETDELETEhttp://host/en/omk/admin/api/v2/servicescontacts/{contact-name}.jsonServices present in NMIS configuration filedelete the contact data./services.jsonServicesGETGET

/contacts/Test-Contact.json

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


Anchor
escalations
escalations

Escalations

Create

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

Services present in NMIS configuration file.


services/dummy

escalations.json

Code Block
{
    "Event": "Descriptionnull,
    "Event_Element": "Dummy",
   Entry for API "Event_Node": "",
    "NameGroup": "dummy",
    "Poll_IntervalLevel0": "5m",
    "PortLevel1": "",
    "Level10": "Service_Name"",
    "Level2": "dummy.exe",
    "Service_TypeLevel3": "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
{Level4": "",
    "DescriptionLevel5": ""Dummy,
   Entry for API"Level6": "",
    "NameLevel7": "dummy_updated",
    "Poll_IntervalLevel8": "10m",
    "PortLevel9": "",
    "Service_Name": "dummy.exe""test",
    "Role": null,
    "Service_Type" :: null,
    "new_type"UpNotify": null
}


ServicesEscalationsDeleteGETDELETEGEThttp://host/en/omk/admin/api/v2/services/{service-name}.jsonDeletes the Service entry from configurations/escalations.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dummy_updatedescalations.json
Code Block
{
    "redirect_to": null,
    "success": 1
}
Anchor
contactscontacts

Contacts

Create

POSTGETGEThttp://host/en/omk/admin/api/v2/contacts/escalations/{escalation-event}.jsonCreate a new contact
contacts

test.json

Code Block
{
    "Contact":
"Test-Contact",     "DutyTimeEvent": ""null,
    "EmailEvent_Element": "",
    "LevelEvent_Node": "",
    "LocationGroup": "",
    "MobileLevel0": "",
    "PagerLevel1": "",
    "PhoneLevel10": "",
    "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 APIhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts/Test-Contact.json
Code Block
{Level2": "",
    "Level3": "",
    "Level4": "",
    "ContactLevel5": "Test-Contact",
    "DutyTimeLevel6": "",
    "EmailLevel7": "",
    "LevelLevel8": "",
    "LocationLevel9": "",
    "MobileName": "test",
    "PagerRole": ""null,
    "PhoneType": ""null,
    "TimeZoneUpNotify": ""null,
    "_id": "Test-Contacttest"
}


ContactsEscalationsUpdatePUThttp://host/en/omk/admin/api/v2/contactsescalations/{contactescalation-nameevent}.jsonUpdate the contact data present in configuration file
contactsTest-Contact

test.json

Code Block
{
    "Event": "test",
    "ContactEvent_Element": "Test-Contact",
    "DutyTimeEvent_Node": "1",
    "EmailGroup": "test@gmail.com",
    "LevelLevel0": "",
    "LocationLevel1": "",
    "MobileLevel10": "",
    "PagerLevel2": "",
    "PhoneLevel3": "",
    "TimeZoneLevel4": ""
}
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
{,
    "Level5": "",
    "redirect_toLevel6": null"",
    "successLevel7": 1
}
Anchor
escalationsescalations

Escalations

Create

POSThttp://host/en/omk/admin/api/v2/escalations.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.json
Code Block
{"",
     "EventLevel8": null"",
    "Event_ElementLevel9": "",
    "Event_NodeName": "test",
    "GroupRole": ""null,
    "Level0Type": ""null,
    "Level1": "",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
{
    "Level10redirect_to": ""null,
    "Level2success": "",
    "Level3": "",
    "Level4": "",
    "Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null
}
Escalations
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

Code Block
{
        "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/escalationsevents.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalationsevents.json
EventsGETGEThttp://host/en/omk/admin/api/v2/escalationsevents/{escalationevent-eventname}.json
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"
}
EscalationsUpdatePUT

events/Self-test-API.json

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

Code Block
{
        "Description": "test event API",
        "Event": "test",
        "Log": "true-change",
        "Notify": "true",
        "Stateful": "false",
        "Status": "false"
    }


EventsDeleteDELETEhttp://host/en/omk/admin/api/v2/escalationsevents/{escalationevent-eventname}.json
escalations

events/Self-test-API.json

Code Block
{
    "Event": "test",
    "Event_Element": "",
    "Event_Node": "",
    "Group": "",
    "Level0": "",
    "Level1": "",{
    "Level10redirect_to": ""null,
    "Level2": "",
    "Level3": "",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

Code Block
  {
        "Level4description": "poll very infr_very.equently",
        "Level5name": "very_very_infrequently",
        "Level6ping": "30m",
    "Level7": "",     "Level8snmp": "1h",
    "Level9": "",     "Nameupdate": "test2d",
    "Role": null,     "Typewmi": null,
 "1h"
  "UpNotify": null }


EscalationsPolling-PolicyDeleteGETDELETEGEThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}polling-policy.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/testpolling-policy.json
Code Block
{
    "redirect_to": null,
    "success": 1
}
Anchor
eventsevents

Events

Create

POSTPolling-PolicyGETGEThttp://host/en/omk/admin/api/v2/eventspolling-policy/{policy name}.json
eventsEventsGETGET

polling-policy/very_very_infrequently.json

Code Block
{
        "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.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/events.json
{
    "_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/eventspolling-policy/{event-policy name}.json
events/Self-test-API

polling-policy/very_very_infrequently.json

Code Block
{   
    	"CancelingEventdescription": "N/Apoll",
    "Descriptionname": "test event APIvery_very_infrequently",
    "Eventping": "Self-test-API30m",
    "Log": "true",
    "Notify": "true",
    "Statefulsnmp": "false1h",
    "Statusupdate": "false2d",
    "_idwmi": "Self-test-API1h"
}
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.jsonEventsPolling-PolicyDeleteDELETEhttp://host/en/omk/admin/api/v2/eventspolling-policy/{event-policy name}.json
events/Self-test-API

polling-policy/very_very_infrequently.json

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


polling-policy

Anchor

polling-policy

users
users

UsersCreatePOSThttp://host/en/omk/admin/api/v2/polling-policyusers.json
/polling-policy.json
Code Block
Code Block
{
    "admission": "30mtrue",
        "snmp    "groups": "1hall",
        "update    "privilege": "2dadministrator",
        "wmi    "user": "1hjohnsmith"
    }


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

users/johnsmith.json

Code Block
{
    "_id": "very_very_infrequently "johnsmith",
    "descriptionadmission": "poll very infr_very.equently "true",
    "namegroups": "very_very_infrequently",
    "ping": "30m" [
        "all"
    ],
    "snmpprivilege":  "1hadministrator",
    "updateuser": "2d",     "wmi": "1h"johnsmith"
}


Polling-PolicyUsersUpdatePUThttp://host/en/omk/admin/api/v2/polling-policyusers/{policy user:name}.json
polling-policy/very_very_infrequently

users/johnsmith.json

Code Block
{   
	    "descriptionadmission":  "pollfalse",
    "namegroups": "very_very_infrequently",
    "ping": "30m" [
        "all"
    ],
    "snmpprivilege":  "1hadministrator",
    "updateuser": "2d",     "wmi": "1h"johnsmith"
}
 


UsersPolling-PolicyDeleteDELETEhttp://host/en/omk/admin/api/v2/polling-policyusers/{policy user:name}.json
polling-policy/very_very_infrequently

users/johnsmith.json

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


Anchor

users

access

users

access

UsersAccessCreatePOSThttp://host/en/omk/admin/api/v2/usersaccess.json
users

access.json

Code Block
{
    "admission"descr": "Enable button Logs",
    "group": "button",
    "level0": "1",
    "level1": "0",
    "level2": "0",
    "level3": "true0",
    "groupslevel4": "all0",
    "privilegelevel5": "administrator0",
    "username": "test_logs"
}


UsersAccessGETGEThttp://host/en/omk/admin/api/v2/usersaccess.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/usersaccess.jsonUsersAccessGETGEThttp://host/en/omk/admin/api/v2/usersaccess/{user:nameaccess-id}.json
users

access/test_logs.json

Code Block
{
    "_id": "test_logs",
    "admission"descr": "Enable button Logs",
    "group": "button",
    "level0": "1",
    "level1": "true0",
    "groupslevel2": [
        "all"
    ]"0",
    "level3": "0",
    "level4": "0",
    "privilegelevel5": "administrator0",
    "username": "test_logs"
}


UsersAccessUpdatePUThttp://host/en/omk/admin/api/v2/usersaccess/{user:nameaccess-id}.json
users

access/test_logs.json

Code Block
{
    "admission"_id": "test_logs",
    "descr": "Enable button Logs",
    "group": "button new",
    "level0": "1",
    "level1": "false0",
    "groupslevel2": [
        "all"
    ]"0",
    "level3": "0",
    "level4": "0",
    "privilegelevel5": "administrator0",
    "username": "test_logs"
}


UsersAccessDeleteDELETEhttp://host/en/omk/admin/api/v2/usersaccess/{user:nameaccess-id}.json
users

access/test_logs.json

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


Anchor

access

customers

access

customers

AccessCustomersCreatePOSThttp://host/en/omk/admin/api/v2/customers.json
access

customers.json

{     "descr": "Enable button Logs",     "group": "button",     "level0": "1",     "level1": "0",     "level2": "0",     "level3
Code Block
Code Block
  {
        "customer": "0test",
            "level4description": "0",
            "level5groups": "0",
            "namelocations": "test_logs"
 null
    }


AccessCustomersGETGEThttp://apollo.opmantek.net:8080host/en/omk/admin/api/v2/customers.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/customers.jsonCustomersGETGEThttp://host/en/omk/admin/api/v2/access/customers/{customer-name}.jsonAccessGETGET
access_logs

.json

Code Block
{
    "_id": "test_logs",
    "descrcustomer": "Enable button Logstest",
    "group": "button",
    "level0": "1",
    "level1": "0",
    "level2": "0",
    "level3": "0",
    "level4description": "0",
    "level5groups": "0",
    "namelocations": "test_logs" null
}


AccessCustomersUpdatePUThttp://host/en/omk/admin/api/v2/customers/{customer-name}.json
access/test_logs.json
Code Block{     "_id": "test_logs",     "descr": "Enable button Logs",     "group": "button new",     "level0": "1",     "level1": "0",     "level2

customers/test.json

Code Block
  {
        "customer": "0test",
            "level3description": "0this is test",
            "level4groups": "0",
            "level5locations": "0",
    "name": "test_logs"
}
AccessDeleteDELETE
 null
    }


CustomersDeleteDELETEhttp://host/en/omk/admin/api/v2/customers/{customer-name}.json
access_logs

.json

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


Anchor

customers

business

customers

business

CustomersBusiness ServicesCreatePOSThttp://host/en/omk/admin/api/v2/businessservices.json
customers

businessservices.json

 

Code Block
  {
        "customerbusinessPriority": "test10",
        "descriptionbusinessService": "test",
        "groupsbusinessUnit": "Sales",
        "locationsserviceType": null "Revenue Generating"
    }


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

Code Block
{
    "_id": "test",
    "customerbusinessPriority": "test10",
    "descriptionbusinessService": "test",
    "groupsbusinessUnit": "Sales",
    "locationsserviceType": null "Revenue Generating"
}


CustomersBusiness ServicesUpdatePUThttp://host/en/omk/admin/api/v2/businessservices/{businessservices-id}.json
customers
Code Block
 
{
        "
customer
businessPriority": "
test
11",
        "
description
businessService": "
this is test
test",
        "
groups
businessUnit": "Sales",
        "
locations
serviceType":
 null
 "Revenue Generating"
    }


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

businessservices/test.json

Code Block
{
    "redirect_to": null,
    "success": 1
}
AnchorbusinessbusinessBusiness ServicesCreatePOSTBusiness ServicesGETGETBusiness ServicesGETGETBusiness ServicesUpdatePUTBusiness ServicesDeleteDELETE