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



/Amsterdam{ Amsterdam Netherlands Amsterdam, Netherlands 523675734 Amsterdam 49041389 " , "_id": "Amsterdam" theme {         "Address1": "",                                     fake geo code       xxxxxxxxx       Mandatory param       yyyyyyyyy                               { "DescriptionDummyEntry for APINamedummyPoll_Interval5mPort Service_Namedummy.exe Service_Type new_typeServicesGETGETservicesServices present in NMIS configuration file.services.json

Anchor
locations
locations
Name

OperationMethodURLResponseExample

Locations

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

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

 
   }


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.jsoncode
LocationsGETFadeToGreyGEThttp://host/en/omk/admin/api/v2/locations{location-name}.jsonLocations present in NMIS configuration file.
 "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": "",
        "redirect_toAddress2": null"",
           "successCity": 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
"",
        "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

locations/Mandatory param.json

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


Anchor
services
services

Services

GET

Create

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


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

Services present in NMIS configuration file.

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/services/dumy.json
codeServicesthemeGETFadeToGrey{ "Description": "GEThttp://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_updated",
    "Poll_Interval": "10m5m",
    "Port": "",
    "Service_Name": "dummy.exe",
    "Service_Type" : "new_type",
    "_id": "dummy"
}


ServicesDeleteUpdateDELETEPUThttp://host/en/omk/admin/api/v2/services/{service-name}.jsonDeletes the Service entry from configurationsUpdate Services entrydummy_updated

dumy.json

Code Block
themeFadeToGrey
{
    "redirect_toDescription": null,"Dummy Entry for   "success": 1
}
Anchor
contactscontacts

Contacts

Create

POSThttp://host/en/omk/admin/api/v2/contacts.jsonCreate a new contacthttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/contacts.json
Code Block
{API",
    "ContactName": "Test-Contactdummy_updated",
    "DutyTimePoll_Interval": "10m",
    "EmailPort": "",
    "LevelService_Name": "dummy.exe",
    "Location": "",
    "Mobile": "",
    "Pager": "",
    "Phone": "",
    "TimeZone": ""
}
ContactsGETGET
Service_Type" : "new_type"
}


ServicesDeleteDELETEhttp://host/en/omk/admin/api/v2/contactsservices/{service-name}.jsonget contact information present in configurationDeletes the Service entry from configurationshostcontacts.json

dummy_updated.json

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


Anchor
contacts
contacts

Contacts

GET

Create

GET
POSThttp://host/en/omk/admin/api/v2/contacts/{contact-name}.jsonget specific contact information using APICreate a new contact/Test-Contact

.json

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

}


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}.jsonUpdate the contact data present in configuration fileget 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": "1",
    "Email": "test@gmail.com",
    "Level": "",
    "Location": "",
    "Mobile": "",
    "Pager": "",
    "Phone": "",
    "TimeZone": ""
}
ContactsDeleteDELETE
,
    "_id": "Test-Contact"
}


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

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

Code Block
{
    "redirect_toContact": null"Test-Contact",
    "successDutyTime": "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
{",
    "Email": "test@gmail.com",
    "Event": null,
    "Event_ElementLevel": "",
    "Event_NodeLocation": "",
    "GroupMobile": "",
    "Level0Pager": "",
    "Level1Phone": "",
    "Level10TimeZone": "",
    "Level2": "",
    "Level3": "",
    "Level4": "",
    "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
{
    "redirect_to": null,
    "Level6success": "",
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
{
    "Level7Event": ""null,
    "Level8Event_Element": "",
    "Level9Event_Node": "",
    "NameGroup": "test",
    "RoleLevel0": null"",
    "TypeLevel1": null"",
    "UpNotifyLevel10": null
}
EscalationsGETGEThttp://host/en/omk/admin/api/v2/escalations.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations.jsonGETGEThttp://host/en/omk/admin/api/v2/escalations/{escalation-event}.jsonhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/escalations/test.json
Code Block
{
    "Event": null"",
    "Level2": "",
    "Level3": "",
    "Level4": "",
    "Level5": "",
    "Event_ElementLevel6": "",
    "Event_NodeLevel7": "",
    "GroupLevel8": "",
    "Level0Level9": "",
    "Level1Name": "test",
    "Level10Role": ""null,
    "Level2Type": ""null,
    "Level3UpNotify": "",
    "Level4": "",
    "Level5": "",
    "Level6": "",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
{
    "Level7Event": ""null,
    "Level8Event_Element": "",
    "Level9Event_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
{
    "Event": "test",
    "Level3": "",
    "Level4": "",
    "Event_ElementLevel5": "",
    "Event_NodeLevel6": "",
    "GroupLevel7": "",
    "Level0Level8": "",
    "Level1Level9": "",
    "Level10Name": "test",
    "Level2Role": ""null,
    "Level3Type": ""null,
    "Level4UpNotify": ""null,
    "Level5_id": "test",
    "Level6
}


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",
    "Level7Event_Element": "",
    "Level8Event_Node": "",
    "Level9Group": "",
    "NameLevel0": "test",
    "RoleLevel1": null"",
    "TypeLevel10": null"",
    "UpNotifyLevel2": null
}
EscalationsDeleteDELETEhttp://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": "",
    "redirect_toLevel4": null"",
    "success": 1
}
Anchor
eventsevents

Events

Create

POSThttp://host/en/omk/admin/api/v2/events.jsonhttp://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"
    }
EventsGETGET
Level5": "",
    "Level6": "",
    "Level7": "",
    "Level8": "",
    "Level9": "",
    "Name": "test",
    "Role": null,
    "Type": null,
    "UpNotify": null
}


EscalationsDeleteDELETEhttp://host/en/omk/admin/api/v2/eventsescalations/{escalation-event}.json
eventshttp:EventsGETGET
Code Block
{
    "redirect_to": null,
    "success": 1
}


Anchor
events
events

Events

Create

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

.json

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


EventsUpdateGETPUTGEThttp://host/en/omk/admin/api/v2/events/{event-name}.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/events/Self-test-API.jsonEventsDeleteGETDELETEGEThttp://host/en/omk/admin/api/v2/events/{event-name}.json
Anchorpolling-policypolling-policyPolling-PolicyCreatePOST
    "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/polling-policyevents/{event-name}.json
pollingpolicy

API.json

Code Block
  {
        "description        "Description": "poll very infr_very.equently "test event API",
        "name        "Event": "very_very_infrequently "test",
        "ping        "Log":  "30mtrue-change",
        "snmp        "Notify":  "1htrue",
        "update        "Stateful":  "2dfalse",
        "wmi        "Status":  "1hfalse"
        }


Polling-PolicyEventsGETDeleteGETDELETEhttp://host/en/omk/admin/api/v2/events/polling{event-policyname}.json
polling-policyGETPolling-PolicyGET
Code Block
{
    "redirect_to": null,
    "success": 1
}


Anchor
polling-policy
polling-policy

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

.json

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


Polling-PolicyUpdateGETPUTGEThttp://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.jsonPolling-Policy
Code Block
{   
	"description": "poll",
    "name": "very_very_infrequently",
    "ping": "30m",
    "snmp": "1h",
    "update": "2d",
    "wmi": "1h"
}
 Polling-PolicyDeleteDELETEGETGEThttp://host/en/omk/admin/api/v2/polling-policy/{policy name}.json
AnchorusersusersUsersCreatePOSThttp:
 "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/users/polling-policy/{policy name}.json
users

polling-policy/very_very_infrequently.json

Code Block
{   
	"description": "poll",
    "name": "very_very_infrequently",
    "admissionping": "true30m",
    "groupssnmp": "all1h",
    "privilegeupdate": "administrator2d",
    "userwmi": "test1h"
}


UsersPolling-PolicyGETDeleteGETDELETEhttp://host/en/omk/admin/api/v2/users/polling-policy/{policy name}.json
users.json

polling-policy/very_very_infrequently.json

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


Anchor
users
users

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

.json

Code Block
{
    "_idadmission": "test",     "admission": "true",
    "groups": [         "all"
    ],
    "privilege":  "administrator",
    "user":  "testjohnsmith"
}


UsersUpdateGETPUTGEThttp://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
test

johnsmith.json

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


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

johnsmith.json

Code Block
{
    "admission": "false",
    "groups": [
        "redirect_toall":
null    ],
    "privilege":    "success"administrator",
    "user": 1"johnsmith"
}


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

users/johnsmith.json

Code Block
{
        "descr": "redirect_to": null,
    "success": 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://apollo.host/en/omk/admin/api/v2/access.json
http://apollo.opmantek.net:8080/en/omk/admin/api/v2/access.jsonAccessGETGEThttp://host/en/omk/admin/api/v2/access/{access-id}.json

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

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


AccessUpdatePUThttp://host/en/omk/admin/api/v2/access/{access-id}.json

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

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


AccessDeleteDELETEhttp://host/en/omk/admin/api/v2/access/{access-id}.json

Anchor
customers
customers

CustomersCreatePOSThttp://host/en/omk/admin/api/v2/customers.json

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

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


CustomersGETGEThttp://host/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/customers/{customer-name}.json

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

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


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

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

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


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

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

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


Anchor
business
business

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

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

Code Block
{
        "businessPriority": "10",
        "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
access_logs

.json

Code Block
{
    "_id": "test_logs",
    "descrbusinessPriority": "Enable button Logs10",
    "groupbusinessService": "button newtest",
    "level0businessUnit": "1Sales",
    "level1": "0",
    "level2"serviceType": "Revenue Generating"
}


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

    
"name": "test_logs" }AccessDeleteDELETE
}


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

.json

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