Event Config Policy Tree

The API is used to fetch details of the event config policy and of the location on which the policy is created. It also provides details of the child locations inheriting the policy.

API Calls
Get

/V7/configuration/locationbased/eventconfig/policytree

Get Event Config Policy Tree

Description Fetches the details of the event config policy and of the location on which the policy is created. It also provides details of the child locations inheriting the policy.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/configuration/locationbased/eventconfig/policytree
Sample code
GET https://training.mojonetworks.com/new/webservice/V7/configuration/locationbased
/eventconfig/policytree
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response is in the application/json format.
JSON Table

Attribute Data Type Description
type String The type of location on which the policy is created. The applicable values are:

  • folderlocation
  • floorlocation
id application/json Location identifier for the policy. The value is of the type Location Id json.
name String Name of the location.
accessibleToUser boolean A true or false value indicating whether the user has rights to access this location.
timezoneId int The JAVA timezone ID of the location.
locationTag String A user-defined tag for the location.
children application/json A list of IDs of the child locations. The ID is a JSON object.
children/type String Its the type of child location ID. The applicable values are:

  • locallocationid
  • remotelocationid

The remotelocationid ID type is applicable only in cluster environments.
children/id int The system-generated unique ID of the child location.
children/name String Name of the child location.
children/accessibleToUser boolean A true or false value indicating whether the user has rights to access this child location.
children/timezoneId int The JAVA timezone ID of the child location.
children/locationTag String A user-defined tag for the child location.
children/children application/json A list of IDs of the child locations. The ID is a JSON object.
children/policy application/json Details of the policy applied or inherited at the location.
children/inherited boolean A true or false value indicating if the child has inherited the policy or not.
policy application/json Details of the policy applied at the location.
policy/policyCreatedAtLocId application/json The ID of the location at which the policy has been defined. For details about the JSON, click Location ID.
policy/policyType String Type of the policy. Applicable value is EVENT_CONFIGURATION_POLICY.
policy/eventTypes application/json A group of attributes related to event types.
policy/eventTypes/majorType String The three broad categories of events. The applicable values are:

  • SECURITY
  • SYSTEM
  • PERFORMANCE
policy/eventTypes/category int The applicable values are:

  • 59 – Rogue AP
  • 51 – Misconfigured AP
  • 66 – Misbehaving Clients
  • 69 – Prevention,
  • 52 – DoS
  • 61 – Adhoc Network
  • 62 – Cracking
  • 60 – Man-in- the-Middle
  • 65 – MAC Spoofing
  • 53 – Reconnaissance
  • 70 – Troubleshooting
  • 71 – Sensor
  • 72 – Server
  • 80 – Coverage
  • 81 – Configuration
  • 82 – Bandwidth
  • 83 – Interference
policy/eventTypes/minorType The minor type of event.
policy/eventTypes/minorTypeParams
policy/eventTypes/minorTypeParams/configId
policy/eventTypes/minorTypeParams/mncConfigId
policy/eventTypes/minorTypeParams/modified
policy/eventTypes/minorTypeParams/mncEventConfigOperation
policy/eventTypes/minorTypeParams/minorTypeAttributeValues
policy/eventTypes/minorTypeParams/minorTypeAttributeValues/minorTypeAttributeId
policy/eventTypes/minorTypeParams/minorTypeAttributeValues/minorTypeAttributeValue
policy/eventTypes/notify boolean A true or false value indicating whether external notifications must be sent if this type of event is raised. True indicates that the external notifications will be sent.
policy/eventTypes/vulnerable boolean A true or false value indicating whether the event type will render the system vulnerable. True indicates that the event type will render the system vulnerable.
policy/eventTypes/displayEvent boolean A true or false value indicating whether the event must be displayed in the event listing if this type of event is raised. True indicates that the event will be displayed in the event listing.
policy/eventTypes/sendMail boolean A true or false value indicating whether an email should be sent if this type of event is raised. True indicates that an email will be sent if this type of event is raised.
policy/eventTypes/severityLevel String The applicable values are:

  • HIGH
  • MEDIUM
  • LOW
inherited boolean A true or false value indicating whether the policy applied at the location is inherited or not.

Sample JSON 
{
	"type": "PolicyLocation",
	"id": {
		"type": "locallocationid",
		"id": 0
	},
	"name": "Locations",
	"accessibleToUser": true,
	"timezoneId": "Asia/Kolkata",
	"locationTag": null,
	"children": [{
			"type": "PolicyLocation",
			"id": {
				"type": "locallocationid",
				"id": -1
			},
			"name": "Unknown",
			"accessibleToUser": true,
			"timezoneId": "Asia/Kolkata",
			"locationTag": null,
			"children": [],
			"policy": null,
			"inherited": true
		},
		{
			"type": "PolicyLocation",
			"id": {
				"type": "locallocationid",
				"id": 3
			},
			"name": "America",
			"accessibleToUser": true,
			"timezoneId": "Asia/Kolkata",
			"locationTag": null,
			"children": [{
					"type": "PolicyLocation",
					"id": {
						"type": "locallocationid",
						"id": 7
					},
					"name": "California",
					"accessibleToUser": true,
					"timezoneId": "Asia/Kolkata",
					"locationTag": null,
					"children": [],
					"policy": null,
					"inherited": true
				},
				{
					"type": "PolicyLocation",
					"id": {
						"type": "locallocationid",
						"id": 5
					},
					"name": "Chicago",
					"accessibleToUser": true,
					"timezoneId": "Asia/Kolkata",
					"locationTag": null,
					"children": [],
					"policy": null,
					"inherited": true
				},
				{
					"type": "PolicyLocation",
					"id": {
						"type": "locallocationid",
						"id": 6
					},
					"name": "Palo Alto",
					"accessibleToUser": true,
					"timezoneId": "Asia/Kolkata",
					"locationTag": null,
					"children": [],
					"policy": null,
					"inherited": true
				}
			],
			"policy": null,
			"inherited": true
		},
		{
			"type": "PolicyLocation",
			"id": {
				"type": "locallocationid",
				"id": 2
			},
			"name": "Asia",
			"accessibleToUser": true,
			"timezoneId": "Asia/Kolkata",
			"locationTag": null,
			"children": [{
				"type": "PolicyLocation",
				"id": {
					"type": "locallocationid",
					"id": 8
				},
				"name": "India",
				"accessibleToUser": true,
				"timezoneId": "Asia/Kolkata",
				"locationTag": null,
				"children": [{
						"type": "PolicyLocation",
						"id": {
							"type": "locallocationid",
							"id": 10
						},
						"name": "Bangalore",
						"accessibleToUser": true,
						"timezoneId": "Asia/Kolkata",
						"locationTag": null,
						"children": [],
						"policy": null,
						"inherited": true
					},
					{
						"type": "PolicyLocation",
						"id": {
							"type": "locallocationid",
							"id": 11
						},
						"name": "Mumbai",
						"accessibleToUser": true,
						"timezoneId": "Asia/Kolkata",
						"locationTag": null,
						"children": [],
						"policy": null,
						"inherited": true
					},
					{
						"type": "PolicyLocation",
						"id": {
							"type": "locallocationid",
							"id": 9
						},
						"name": "Pune",
						"accessibleToUser": true,
						"timezoneId": "Asia/Kolkata",
						"locationTag": null,
						"children": [],
						"policy": null,
						"inherited": true
					}
				],
				"policy": null,
				"inherited": true
			}],
			"policy": null,
			"inherited": true
		},
		{
			"type": "PolicyLocation",
			"id": {
				"type": "locallocationid",
				"id": 1
			},
			"name": "MSU Child",
			"accessibleToUser": true,
			"timezoneId": "Asia/Kolkata",
			"locationTag": null,
			"children": [],
			"policy": null,
			"inherited": true
		},
		{
			"type": "PolicyLocation",
			"id": {
				"type": "locallocationid",
				"id": 19
			},
			"name": "SwapnilD",
			"accessibleToUser": true,
			"timezoneId": "Asia/Kolkata",
			"locationTag": null,
			"children": [],
			"policy": null,
			"inherited": true
		},
		{
			"type": "PolicyLocation",
			"id": {
				"type": "locallocationid",
				"id": 17
			},
			"name": "VijayP",
			"accessibleToUser": true,
			"timezoneId": "Asia/Kolkata",
			"locationTag": null,
			"children": [],
			"policy": null,
			"inherited": true
		}
	],
	"policy": {
		"policyCreatedAtLocId": null,
		"policyType": "EVENT_CONFIGURATION_POLICY",
		"eventTypes": [{
			"majorType": "WIFI",
			"category": 84,
			"minorType": 1013,
			"minorTypeParams": [{
					"configId": 100,
					"mncConfigId": 0,
					"modified": false,
					"mncEventConfigOperation": null,
					"minorTypeAttributeValues": [{
							"minorTypeAttributeId": "CLIENT_FAILURE_REASON",
							"minorTypeAttributeValue": "CLIENT_FAILURE_REASON_NETWORK"
						},
						{
							"minorTypeAttributeId": "NO_OF_CLIENT_IN_FAILURE",
							"minorTypeAttributeValue": "3"
						}
					]
				},
				{
					"configId": 99,
					"mncConfigId": 0,
					"modified": false,
					"mncEventConfigOperation": null,
					"minorTypeAttributeValues": [{
							"minorTypeAttributeId": "CLIENT_FAILURE_REASON",
							"minorTypeAttributeValue": "CLIENT_FAILURE_REASON_ASSOCIATION"
						},
						{
							"minorTypeAttributeId": "NO_OF_CLIENT_IN_FAILURE",
							"minorTypeAttributeValue": "2"
						}
					]
				}
			],
			"notify": true,
			"vulnerable": false,
			"displayEvent": true,
			"sendMail": false,
			"severityLevel": "HIGH"
		}]
	},
	"inherited": false
}