Event policy management endpoints in the REST API
The following section provides a list of supported endpoints and an overview about running these endpoints. Before you run an endpoint, you must authenticate yourself. For more information, see
Access and authentication for the REST API
Event policies
You can create, update, delete, retrieve, search, enable, and disable event policies by using REST APIs.
POST /event_policies
https://<tenant-url>/events-service/api/v1.0/event_policies https://HostA.bmc.com/events-service/api/v1.0/event_policiesContent-Type: application/json
Authorization: Bearer <JWT_token>For instructions on obtaining the JWT token, see
Access and authentication for the REST API.
.
Parameter details
| Parameter name | Value type | Located in | Mandatory | Description |
|---|---|---|---|---|
name | String | Body | Yes | The policy name. This value cannot be empty or null. |
| String | Body | No | The policy description |
executionOrder | Integer | Body | Yes | The policy precedence Valid values: 0-9999 |
enabled | Boolean | Body | No | The option to enable the policy |
selectorCriteria | String | Body | Yes | The event selection criteria. The slot operator used in the criteria must be as per the data type of the slot. The value for slots, which have the date data type must be a timestamp value. |
selectorCriteriaList | String array | Body | Yes | The event selection criteria. Use this attribute to specify multiple classes in the event selection criteria. We recommend that you use the If you specify values in both |
types | String array | Body | Yes | The policy type. This value cannot be empty or null. Valid values:
|
configurations | Array | Body | Yes | The policy configurations. This value cannot be empty or null. You cannot add multiple configurations for time-based enrichment or suppression policies. |
configOrder | Integer | Body | Yes | The order of configurations. This value must uniquely identify the list of policy configurations. |
definition | Object | Body | Yes | The policy definition |
type | String | Body | Yes | The policy type. This value cannot be empty or null. The value specified for this parameter in the list of policy configurations must be present in the policy types list. Valid values:
|
subType | String | Body | No | The policy sub type For example, dynamic enrichment is a subtype of an advanced enrichment policy. |
timeframeStatus | String | Body | No | The time frame status |
Request body
Example request body
Successful response
{
"message": "Created event policy",
"object": [
"696447ff-008d-4ef7-a417-2c506abad552"
]
}Unsuccessful responses
Scenario 1: You do not specify a policy name.
[
{
"key": "400",
"level": "ERROR",
"message": "Name is a mandatory and cannot be null or empty.",
"additionalInfo": []
}
]Scenario 2: You specify a slot name in the event selection criteria that is not present in the event class.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid EventSelectorCriteria: 1 Condition value is al_parameter_name.",
"additionalInfo": []
}
]Scenario 3: You specify an invalid value for a slot having the ENUM data type.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid EventSelectorCriteria: 1 Invalid slotValue Minor.",
"additionalInfo": []
}
]Scenario 4: You specify an invalid key in the enrich node definition for the configurations attribute.
Scenario 5: You specify an invalid definition type for the configurations attribute.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid type in Refine definition.Expected type is 'root'.",
"additionalInfo": []
}
]Scenario 6: You do not specify a definition label for the configurations attribute.
[
{
"key": "400",
"level": "ERROR",
"message": "label is mandatory in REFINE definition and cannot be null or empty.",
"additionalInfo": []
}
]Scenario 7: You include the else definition without the if definition for the configurations attribute.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid type else without any if definition.",
"additionalInfo": []
}
]Scenario 8: You specify an invalid type for the enrich node in the if definition for the configurations attribute.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid type enrich1 in if definition.",
"additionalInfo": []
}
]Scenario 9: You specify a policy name that already exists.
[
{
"key": "POLICY_ALREADY_EXIST",
"level": "ERROR",
"message": "[Failed to create event policy, entry with same name already exists]",
"additionalInfo": [
[]
]
}
]Scenario 10: The number of classes that you specify in the event selection criteria exceeds the maximum class limit.
[
{
"key": "400",
"level": "ERROR",
"message": "Maximum event selection criteria allowed is 5",
"additionalInfo": []
}
]Scenario 11: You specify an event slot in the policy configuration that does not belong to any of the classes that you specified in the event selection criteria.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid value $NEW.custom_class_slot_1 in data definition.",
"additionalInfo": []
}
]POST /event_policies/search
https://<tenant-url>/events-service/api/v1.0/event_policies/search https://HostA.bmc.com/events-service/api/v1.0/event_policies/searchContent-Type: application/json
Authorization: Bearer <JWT_token>For instructions on obtaining the JWT token, see
Access and authentication for the REST API.
.
Parameter details
| Parameter name | Value type | Located in | Mandatory | Description |
|---|---|---|---|---|
query | String | Body | No | The conditions for searching the policy. You can specify the query conditions by using the following operators:
You can use a single column or a combination of the following columns to search a policy:
You can use the For example,
|
recordsPerPage | Integer | Body | No | The number of search results on every page |
pageIndex | Integer | Body | No | The page index. The value for the index starts with 1. This parameter supports pagination. For example, There are a total of 50 records and the records listed on the first page are 25. To view records on the next page, specify the |
sortCriteria | String | Body | No | The criteria to sort the event policies. You can use a single column or a combination of the following columns to sort policies:
|
Request body
{
"query": "string",
"recordsPerPage": integer,
"pageIndex": integer,
"sortCriteria": "string"
}Example request body
{
"query": "enabled=false and name like '%Lookup123%' and ('ADVANCED_ENRICHMENT'=ANY(TYPES) or 'BASIC_ENRICHMENT'=ANY(TYPES))",
"recordsPerPage": 25,
"pageIndex": 1,
"sortCriteria": "modificationTime desc"
}Successful response
{
"totalRecords": 2,
"policies": [
{
"tenantId": "1904152611",
"id": "261dc2cb-30d3-11ec-b5a6-8b5aa8089475",
"name": "test all",
"types": [
"SUPPRESSION",
"TIME_BASED"
],
"description": "",
"executionOrder": 9999,
"selector": "261ab58a-30d3-11ec-b5a6-076f20873c08",
"selectorCriteriaList": [
"( class equals 'ALARM' ) AND ( al_parameter_name contains 'CPU' ) AND ( msg contains 'increasing' )",
"( class equals 'PATROL_EV' ) AND ( p_origin contains 'clm' ) AND ( msg contains 'increasing' )"
],
"owner": "admin",
"enabled": false,
"readOnly": false,
"creationTime": 1634644397766,
"modificationTime": 1634644397766,
"configurations": [
{
"tenantId": "1904152611",
"policyId": "261dc2cb-30d3-11ec-b5a6-8b5aa8089475",
"id": "261dc2cc-30d3-11ec-b5a6-5d980b426c68",
"type": "SUPPRESSION",
"configOrder": 1,
"creationTime": 0,
"modificationTime": 0,
"definition": {
"processing_post_action": {
"old_event_post_action": "",
"new_event_post_action": "drop"
},
"processing_action": {}
},
"timeframeStatus": ""
},
{
"tenantId": "1904152611",
"policyId": "261dc2cb-30d3-11ec-b5a6-8b5aa8089475",
"id": "261dc2cd-30d3-11ec-b5a6-f1cf9e8bb3b4",
"type": "TIME_BASED",
"configOrder": 2,
"creationTime": 0,
"modificationTime": 0,
"definition": {
"children": [
{
"duration": 1800,
"unit": "Minutes",
"children": [
{
"children": [],
"label": "enrich",
"type": "enrich",
"value": "applied",
"key": "$NEW.msg"
}
],
"label": "time",
"type": "timeout",
"value": "",
"key": ""
}
],
"label": "time based\n",
"type": "root"
},
"timeframeStatus": ""
}
]
},
{
"tenantId": "1904152611",
"id": "e3a81c55-2c00-11ec-aed2-37a037c9b426",
"name": "TestAshish",
"types": [
"NOTIFICATION"
],
"description": "",
"executionOrder": 9999,
"selector": "e2bf6a04-2c00-11ec-aed2-750996bd5bf1",
"selectorCriteriaList": [
"( class equals 'ALARM' ) AND ( al_parameter_name contains 'CPU' ) AND ( msg contains 'increasing' )",
"( class equals 'PATROL_EV' ) AND ( p_origin contains 'clm' ) AND ( msg contains 'increasing' )"
],
"owner": "admin",
"enabled": false,
"readOnly": false,
"creationTime": 1634114289767,
"modificationTime": 1634551403181,
"configurations": [
{
"tenantId": "1904152611",
"policyId": "e3a81c55-2c00-11ec-aed2-37a037c9b426",
"id": "e3ab0286-2c00-11ec-aed2-c35f90611a75",
"type": "NOTIFICATION",
"configOrder": 1,
"creationTime": 0,
"modificationTime": 0,
"definition": {
"processing_action": {
"notificationService": "incident"
}
},
"timeframeStatus": ""
}
]
}
]
}Unsuccessful responses
Scenario 1: You specify an invalid column name in the sort criteria
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid column name in sort criteria",
"additionalInfo": []
}
]Scenario 2: You misspell a column name
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid column name nam",
"additionalInfo": []
}
]GET /event_policies/<id>
https://<tenant-url>/events-service/api/v1.0/event_policies/<id> https://HostA.bmc.com/events-service/api/v1.0/event_policies/261dc2cb-30d3-11ec-b5a6-8b5aa8089475Content-Type: application/json
Authorization: Bearer <JWT_token>For instructions on obtaining the JWT token, see
Access and authentication for the REST API.
.
Parameter details
| Parameter name | Value type | Located in | Mandatory | Description |
|---|---|---|---|---|
| String | Path | Yes | The event policy ID for which you want to retrieve the policy details. |
Successful responses
Unsuccessful responses
Scenario 1: You specify an invalid policy ID format.
A valid policy ID does not exceed 36 characters. For example, 41f046ff-25ca-11ec-aa29-31654db26e83
{
"errorCode": 400,
"message": "Invalid id format"
}Scenario 2: You specify a policy ID that does not exist.
[
{
"key": "Not Found",
"level": "ERROR",
"message": "No policy found matching input request!",
"additionalInfo": null
}
]PUT /event_policies/<id>
https://<tenant-url>/events-service/api/v1.0/event_policies/<id> https://HostA.bmc.com/events-service/api/v1.0/event_policies/261dc2cb-30d3-11ec-b5a6-8b5aa8089475Content-Type: application/json
Authorization: Bearer <JWT_token>For instructions on obtaining the JWT token, see
Access and authentication for the REST API.
.
Parameter details
| Parameter name | Value type | Located in | Mandatory | Description |
|---|---|---|---|---|
id | String | Path | Yes | The event policy ID |
| String | Body | No | The policy description |
executionOrder | Integer | Body | Yes | The policy precedence Valid values: 0-9999 |
enabled | Boolean | Body | No | The option to enable the policy |
selectorCriteria | String | Body | Yes | The event selection criteria. The slot operator used in the criteria must be as per the data type of the slot. The value for slots, which have the date data type must be a timestamp value. |
selectorCriteriaList | String array | Body | Yes | The event selection criteria. Use this attribute to specify multiple classes in the event selection criteria. We recommend that you use the If you specify values in both |
types | String array | Body | Yes | The policy type. This value cannot be empty or null. Valid values:
|
configurations | Array | Body | Yes | The policy configurations. This value cannot be empty or null. You cannot add multiple configurations for time-based enrichment or suppression policies. |
configOrder | Integer | Body | Yes | The order of configurations. This value must uniquely identify the list of policy configurations. |
policyId | String | Body | No | The event policy ID |
id | String | Body | No | The configuration ID for the policy |
definition | Object | Body | Yes | The policy definition |
type | String | Body | Yes | The policy type. This value cannot be empty or null. Valid values:
|
subType | String | Body | No | The policy sub type For example, dynamic enrichment is a subtype of an advanced enrichment policy. |
timeframeStatus | String | Body | No | The time frame status |
Request body
Example request body
When you update a time-based policy, you can specify the duration attribute value as an event slot or a global variable that represents an integer in the string format.
Successful response
{
"message": "Updated event policy",
"object": [
"696447ff-008d-4ef7-a417-2c506abad552"
]
}Unsuccessful responses
Scenario 1: You specify an invalid event selection criteria.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid EventSelectorCriteria: 1 Invalid Condition Name (msg.",
"additionalInfo": []
}
]Scenario 2: You specify an invalid key in the enrich node definition for the configurations attribute.
Scenario 3: You specify an invalid definition type for the configurations attribute.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid type in Refine definition.Expected type is 'root'.",
"additionalInfo": []
}
]Scenario 4: You do not specify a definition label for the configurations attribute.
[
{
"key": "400",
"level": "ERROR",
"message": "label is mandatory in REFINE definition and cannot be null or empty.",
"additionalInfo": []
}
]Scenario 5: You include the else definition without the if definition for the configurations attribute.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid type else without any if definition.",
"additionalInfo": []
}
]Scenario 6: You specify an invalid type for the enrich node in the if definition for the configurations attribute.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid type enrich1 in if definition.",
"additionalInfo": []
}
]Scenario 7: You attempt to update the policy name, which is non-editable.
[
{
"key": "validation.schema.additionalProperties",
"level": "ERROR",
"message": "Object instance has properties which are not allowed by the schema: [\"name\"]",
"additionalInfo": []
}
]Scenario 8: You specify a policy ID that does not exist.
[
{
"key": "Not Found",
"level": "ERROR",
"message": "No policy found matching input request!",
"additionalInfo": null
}
]Scenario 9: The number of classes that you specify in the event selection criteria exceeds the maximum class limit.
[
{
"key": "400",
"level": "ERROR",
"message": "Maximum event selection criteria allowed is 5",
"additionalInfo": []
}
]Scenario 10: You specify an event slot in the policy configuration that does not belong to any of the classes that you specified in the event selection criteria.
[
{
"key": "400",
"level": "ERROR",
"message": "Invalid value $NEW.custom_class_slot_1 in data definition.",
"additionalInfo": []
}
]POST /event_policies/delete
https://<tenant-url>/events-service/api/v1.0/event_policies/delete https://HostA.bmc.com/events-service/api/v1.0/event_policies/deleteContent-Type: application/json
Authorization: Bearer <JWT_token>For instructions on obtaining the JWT token, see
Access and authentication for the REST API.
.
Parameter details
| Parameter name | Value type | Located in | Mandatory | Description |
|---|---|---|---|---|
ids | String | Body | Yes | Comma-separated list of policy IDs that you want to delete. |
Request body
{
"ids": [
"string"
]
}Example request body
{
"ids": [
"d6d8863c-3df8-11eb-9812-a972fa20cf57",
"d32fc78e-3558-11eb-9812-c3cbbc933af7"
]
}Successful response
{
"message": "Deleted event policies",
"object": [
"696447ff-008d-4ef7-a417-2c506abad552"
]
}Unsuccessful responses
Scenario 1: You specify multiple policy IDs out of which a few exist and a few do not.
{
"status": "207",
"succeeded": [
"5ec64ed1-14a4-11ed-b8d2-f56ae23d81b5"
],
"failed": [
{
"id": "76859e26-a101-11ec-86ff-b3fdef7f5366",
"message": "Failed to delete event policies, entry doesn't exist in database]"
},
{
"id": "76859e26-a101-11ec-86fd-b3fdef7f5366",
"message": "Failed to delete event policies, entry doesn't exist in database]"
}
]
}Scenario 2: You specify an invalid policy ID.
[
{
"key": "400",
"level": "ERROR",
"message": "Bad Request : Invalid resource id specified: 11",
"additionalInfo": []
}
]Scenario 3: The object instance has properties that are not allowed by the schema.
Scenario 4: You attempt to delete multiple policies that do not exist.
[
{
"key": "POLICY_NOT_EXIST",
"level": "ERROR",
"message": "[Failed to delete policy, entry doesn't exist in database]",
"additionalInfo": [
[
"76859e26-a101-11ec-86ff-b3fdef7f5366",
"76859e26-a101-11ec-86fd-b3fdef7f5366"
]
]
}
]Scenario 5: You specify a policy ID that does not exist.
[
{
"key": "POLICY_NOT_EXIST",
"level": "ERROR",
"message": "[Failed to delete policy, entry doesn't exist in database]",
"additionalInfo": [
[
"ff921989-9497-11ec-ab01-23d7965a32bc"
]
]
}
]POST /event_policies/enable
https://<tenant-url>/events-service/api/v1.0/event_policies/enable https://HostA.bmc.com/events-service/api/v1.0/event_policies/enableContent-Type: application/json
Authorization: Bearer <JWT_token>For instructions on obtaining the JWT token, see
Access and authentication for the REST API.
.
Parameter details
| Parameter name | Value type | Located in | Mandatory | Description |
|---|---|---|---|---|
ids | String | Body | Yes | Comma-separated list of policy IDs that you want to enable. |
Request body
{
"ids": [
"string"
]
}Example request body
{
"ids": [
"d6d8863c-3df8-11eb-9812-a972fa20cf57",
"d32fc78e-3558-11eb-9812-c3cbbc933af7"
]
}Successful response
{
"message": "Enabled event policies",
"object": [
"696447ff-008d-4ef7-a417-2c506abad552"
]
}Unsuccessful responses
Scenario 1: You do not specify a policy ID
[
{
"key": "400",
"level": "ERROR",
"message": "Bad Request : Property is null or empty : resources",
"additionalInfo": []
}
]Scenario 2: You attempt to enable a policy that does not exist
[
{
"key": "404",
"level": "ERROR",
"message": "[Failed to enable policy, entry doesn't exist in database]",
"additionalInfo": [
[
"d32fc78e-3558-11eb-9812-c3cbbc933af7"
]
]
}
]POST /event_policies/disable
https://<tenant-url>/events-service/api/v1.0/event_policies/disable https://HostA.bmc.com/events-service/api/v1.0/event_policies/disableContent-Type: application/json
Authorization: Bearer <JWT_token>For instructions on obtaining the JWT token, see
Access and authentication for the REST API.
.
Parameter details
| Parameter name | Value type | Located in | Mandatory | Description |
|---|---|---|---|---|
ids | String | Body | Yes | Comma-separated list of policy IDs that you want to disable. |
Request body
{
"ids": [
"string"
]
}Example request body
{
"ids": [
"d6d8863c-3df8-11eb-9812-a972fa20cf57",
"d32fc78e-3558-11eb-9812-c3cbbc933af7"
]
}Successful response
{
"message": "Disabled event policies",
"object": [
"696447ff-008d-4ef7-a417-2c506abad552"
]
}Unsuccessful responses
Scenario 1: You do not specify a policy ID
[
{
"key": "400",
"level": "ERROR",
"message": "Bad Request : Property is null or empty : resources",
"additionalInfo": []
}
]Scenario 2: You attempt to disable a policy that does not exist
[
{
"key": "404",
"level": "ERROR",
"message": "[Failed to disable policy, entry doesn't exist in database]",
"additionalInfo": [
[
"ab56eb68-9499-11ec-ab01-a798a9069314"
]
]
}
]
Comments
Log in or register to comment.