Event Integration Service API endpoints
Use the Event Integration Service API endpoints to know the details of events. Before you run an endpoint, make sure that you authenticate the API request.
{
"openapi": "3.0.2",
"info": {
"version": "1.2.22",
"title": "Event Integration Service",
},
"tags": [
{
"name": "About",
"description": "The status of the service"
},
{
"name": "Events",
"description": "all operation related to events"
},
{
"name": "SearchEvent",
"description": "search operations"
}
],
"paths": {
"/opt/api/eventintegration/about": {
"get": {
"summary": "About info",
"description": "About info",
"operationId": "about",
"security": [],
"tags": [
"About"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AboutInfo"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
}
}
}
},
"/opt/api/v1/eventintegration/events/types": {
"get": {
"summary": "Get list of events types",
"description": "Get list of events types",
"operationId": "eventsTypes",
"tags": [
"Events"
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventType"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
}
}
}
},
"/opt/api/v1/eventintegration/events/search": {
"post": {
"summary": "SearchEvents",
"description": "Full search on the event s. Results are sorted by name.\n\n* identifier: id of the event\nSupported operators: IN\n* source_class: search for events based on their type source class. e.g 'HOST_STATUS'\nSupported operators: IN\n* event_type : search for events based on their type. e.g 'NOT_PLANNED.INCIDENT'\nSupported operators: IN\n* message: search for events based on their name.\nSupported operators: IN,LIKE\n* entity_id\nSupported operators: IN\n* node_id\nSupported operators: IN \n* creation_time: search for events based on their creation time. Values as ISO date format: e.g. '2020-01-01T00:15:00Z'\nSupported operators: GREATER_THAN, LOWER_THAN\n* arrival_time: search for events based on their arrival time. Values as ISO date format: e.g. '2020-01-01T00:15:00Z'\nSupported operators: GREATER_THAN, LOWER_THAN\n* intervent_time: search for events based on their intervention time. Values as ISO date format: e.g. '2020-01-01T00:15:00Z'\nSupported operators: GREATER_THAN, LOWER_THAN\n* resolution_time: search for events based on their resolution time. Values as ISO date format: e.g. '2020-01-01T00:15:00Z'\nSupported operators: GREATER_THAN, LOWER_THAN\n* details: search for events based on their description\nSupported operators: IN,LIKE\n* color: search for events based on their color. e.g. '#392626'\nSupported operators: IN\n* period: search for events based on their period, in seconds\nSupported operators: IN\n* recurrent_ev_since_time: search for recurrent events starting from the time. Values as ISO date format: e.g. '2020-01-01T00:15:00Z'\nSupported operators: GREATER_THAN, LOWER_THAN\n* recurrent_ev_to_time: search for recurrent events ending to the time. Values as ISO date format: e.g. '2020-01-01T00:15:00Z'\nSupported operators: GREATER_THAN, LOWER_THAN\n* severity: search for events based on their severity.\nSupported operators: IN\n* service_unavailability: search for events based on their service_unavailability. Values are boolean, e.g. 'true','false'\nSupported operators: IN\n* tracing_type : search for events based on their tracing_type\nSupported operators: IN\n* occurrences : search for events based on their occurrences. e.g. '3'\nSupported operators: IN\n* srcid : search for events based on the ETL source id generator\nSupported operators: IN\n* source_event_id: search for event base on the source event identifier\nSupported operators: IN,LIKE\n* pending_time : search for events based on their pending time. Values as ISO date format: e.g. '2020-01-01T00:15:00Z'\nSupported operators: GREATER_THAN, LOWER_THAN\n* state_transition_time: search for events based on their transition time. Values as ISO date format: e.g. '2020-01-01T00:15:00Z'\nSupported operators: GREATER_THAN, LOWER_THAN\n* status: the status of the event. It can be: 'OPEN', 'ACK', 'ASSIGNED', 'CLOSED', 'BLACKOUT'\nSupported operators: IN\n",
"operationId": "search",
"tags": [
"SearchEvent"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequest"
}
}
},
"description": "Search Request",
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResults"
},
"example": {
"pagination": {
"page": 0,
"size": 100,
"total_records": 1000,
"has_more_data": true
},
"results": [
{
"identifier": "d682dd48-378a-11ea-978f-2e728ce88125",
"source_identifier": "pe-pun-bco-dv05.bmc.com",
"source_event_id": "18",
"incident_id": 3283659500474,
"class": "OptimizeEvent",
"arrival_time": 1603862648349,
"creation_time": 1603862648349,
"intervent_time": 1603862648349,
"resolution_time": 1603862648349,
"message": "Host disconnected from cluster",
"details": "Disconnected from pe-pun-bco-dv05.bmc.com in TSCO-Datastore. Reason: User request",
"note": "Request from user 12345",
"event_type": "PLANNED.CHANGE",
"color": "#2CAE8B",
"period": 0,
"recurrent_ev_since_time": 0,
"recurrent_ev_to_time": 0,
"severity": "MINOR",
"service_unavailability": false,
"source_class": "HOST_STATUS",
"tracing_type": "STATESUMMARY",
"occurrences": 1,
"srcid": 100,
"pending_time": 0,
"state_transition_time": 0,
"entity_id": 78945
}
]
}
}
}
},
"204": {
"description": "No Content"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/eventintegration/events/close": {
"post": {
"summary": "CloseEvents",
"description": "Close open events using following filters:\n\n* event_type: type of the event\nSupported operators: IN\n* entity_id: id of the entity\nSupported operators: IN\n",
"operationId": "close",
"tags": [
"CloseEvent"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloseRequest"
}
}
},
"description": "Search Request",
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/eventintegration/events": {
"post": {
"summary": "Create events",
"description": "This endpoint permits to create new events",
"operationId": "createEvents",
"tags": [
"Events"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEventsRequest"
}
}
},
"description": "Event to create",
"required": true
},
"responses": {
"201": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtendedEvent"
}
},
"example": [
{
"identifier": "eps.1298610340.5262372786799.14ac4e57-474d-46ae-942a-8ab80ff1cd41",
"source_identifier": "pe-pun-bco-dv05.bmc.com",
"source_event_id": "18",
"incident_id": "3283659500474",
"class": "OptimizeEvent",
"arrival_time": "2020-01-01T00:00:00Z",
"creation_time": "2020-01-01T00:00:00Z",
"intervent_time": "2020-01-01T00:00:00Z",
"resolution_time": "2020-01-01T00:00:00Z",
"message": "Host disconnected from cluster",
"details": "Disconnected from pe-pun-bco-dv05.bmc.com in TSCO-Datastore. Reason: User request",
"note": "Request from user 12345",
"event_type": "PLANNED.CHANGE",
"color": "#2CAE8B",
"period": 0,
"recurrent_ev_since_time": "2020-01-01T00:00:00Z",
"recurrent_ev_to_time": "2020-01-01T00:00:00Z",
"severity": "MINOR",
"service_unavailability": false,
"source_class": "HOST_STATUS",
"tracing_type": "STATESUMMARY",
"occurrences": 1,
"srcid": 100,
"pending_time": 0,
"state_transition_time": "2020-01-01T00:00:00Z",
"entity_id": 78945
}
]
}
}
},
"204": {
"description": "No Content"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/eventintegration/events/{identifier}": {
"patch": {
"summary": "Update event",
"description": "This endpoint permits to update an event",
"operationId": "updateEvent",
"tags": [
"Events"
],
"parameters": [
{
"in": "path",
"name": "identifier",
"description": "Identifier of the event",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventRequest"
}
}
},
"description": "Event to update",
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
}
},
"components": {
"schemas": {
"AboutInfo": {
"title": "About info",
"description": "Basic information about the running service",
"type": "object",
"properties": {
"api_versions": {
"type": "array",
"items": {
"type": "string"
},
"example": [
1
]
},
"version": {
"type": "string",
"example": 1
},
"component": {
"type": "string",
"example": "analysis-service"
},
"product": {
"type": "string",
"example": "TrueSight Helix Capacity Optimization"
}
}
},
"ApiError": {
"title": "ApiError",
"description": "An error message returned by the server",
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"transient": {
"type": "boolean"
}
}
},
"EventType": {
"title": "Event type",
"description": "Event type definition",
"type": "object",
"properties": {
"eventtypeid": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "PLANNED.GENERIC"
},
"description": {
"type": "string",
"example": "Generic"
},
"color": {
"type": "string",
"example": "#FF0000"
}
}
},
"PaginationRequest": {
"type": "object",
"required": [
"page",
"size"
],
"properties": {
"page": {
"type": "integer",
"description": "The page requested, starting from 0",
"example": 0
},
"size": {
"type": "integer",
"description": "The number of element in the page",
"example": 50
}
}
},
"Sorting": {
"title": "Sorting",
"description": "Sorting filter",
"type": "object",
"properties": {
"sort": {
"type": "string",
"description": "Sorting mode",
"default": "ASC",
"example": "ASC",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"description": "Field to sort",
"example": ""
}
}
},
"SearchFilter": {
"title": "Search filter request",
"description": "Filter for search.",
"type": "object",
"required": [
"field_name",
"operator",
"values"
],
"properties": {
"field_name": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SearchCondition": {
"title": "Search condition request",
"description": "Join more SearchFilter",
"type": "object",
"required": [
"filters"
],
"properties": {
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchFilter"
}
}
}
},
"SearchRequest": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/PaginationRequest"
},
"sorting": {
"$ref": "#/components/schemas/Sorting"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchCondition"
}
}
}
},
"PaginationResult": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "The page requested, starting from 0"
},
"size": {
"type": "integer",
"description": "The number of element requested for this page"
},
"total_record": {
"type": "integer",
"description": "The total number of results."
},
"has_more_data": {
"type": "boolean",
"description": "True if there are subsequent pages."
}
}
},
"Event": {
"type": "object",
"required": [
"event_type",
"source_identifier",
"message"
],
"properties": {
"source_event_id": {
"description": "event identifier for the source that generate the event",
"type": "string",
"example": "19"
},
"creation_time": {
"description": "time when the event has happened",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"intervent_time": {
"description": "time when the event has been processed",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"resolution_time": {
"description": "time when the event has been resolved",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"message": {
"description": "the message associated to the event",
"type": "string",
"minLength": 1,
"example": "Host disconnected from cluster"
},
"details": {
"description": "a detailed message",
"type": "string",
"example": "Disconnected from pe-pun-bco-dv05.bmc.com in TSCO-Datastore. Reason: User request"
},
"note": {
"description": "a note associated to the event",
"type": "string",
"example": "Request from user 12345"
},
"event_type": {
"description": "Type of event. Possible values:\n* NOT_PLANNED.INCIDENT\n* PLANNED.GENERIC\n* PLANNED.MAINTENANCE\n* PLANNED.CHANGE\n* NOT_PLANNED.PROBLEM\n* NOT_PLANNED.ERROR\n* UNKNOWN\n* DETECTED\n",
"type": "string",
"pattern": "^(NOT_PLANNED.INCIDENT|PLANNED.GENERIC|PLANNED.MAINTENANCE|PLANNED.CHANGE|NOT_PLANNED.PROBLEM|NOT_PLANNED.ERROR|UNKNOWN|DETECTED)$",
"example": "NOT_PLANNED.INCIDENT"
},
"color": {
"description": "color used for plot the event",
"type": "string",
"example": "#2CAE8B"
},
"period": {
"description": "For repeated events, period in seconds",
"type": "integer",
"format": "int64",
"example": 3600
},
"recurrent_ev_since_time": {
"description": "For repeatable events, start time",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"recurrent_ev_to_time": {
"description": "For repeatable events, end time",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"severity": {
"description": "level of severity",
"type": "string",
"default": "MINOR",
"example": "OK",
"enum": [
"UNKNOWN",
"OK",
"INFO",
"WARNING",
"MINOR",
"MAJOR",
"CRITICAL"
]
},
"service_unavailability": {
"description": "Can cause a service unavailability",
"type": "boolean",
"example": true
},
"source_class": {
"description": "Source class",
"type": "string",
"example": "HOST_STATUS"
},
"occurrences": {
"description": "Count of occurrence",
"type": "integer",
"example": 3
},
"srcid": {
"description": "ETL that has generated the event",
"type": "integer",
"example": 3
},
"pending_time": {
"description": "Times between creation_time and resolution_time",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"state_transition_time": {
"description": "State transition time",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"entity_id": {
"description": "Entity id related to the event",
"type": "number",
"example": 78945
}
}
},
"ExtendedEvent": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Event"
},
{
"type": "object",
"properties": {
"identifier": {
"description": "id of the event",
"type": "string",
"example": "eps.1298610340.5262372786799.14ac4e57-474d-46ae-942a-8ab80ff1cd41"
},
"class": {
"description": "the type of event",
"type": "string",
"example": "OptimizeEvent"
},
"source_identifier": {
"description": "name of the host that generate the event",
"type": "string",
"example": "pe-pun-bco-dv05.bmc.com"
},
"tracing_type": {
"description": "Automatic value; valid values are STATELESS if the row has only creation_time, STATESUMMARY if the row has both creation_time and resolution_time, STATETRANSITION if the row has state_transition_time",
"type": "string",
"example": "STATELESS",
"enum": [
"STATELESS",
"STATESUMMARY",
"STATETRANSITION"
]
},
"arrival_time": {
"description": "time when the event has been created",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"creation_time": {
"description": "time when the event has happened",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"predicted_saturation_date": {
"description": "time when the predicted saturation",
"type": "string",
"format": "date-time",
"example": "2022-01-01T00:00:00Z"
},
"incident_id": {
"description": "id of the incident",
"type": "string",
"example": "12345656"
},
"status": {
"description": "the status of the event. It can be: 'OPEN', 'ACK', 'ASSIGNED', 'CLOSED', 'BLACKOUT'\n",
"type": "string",
"example": "OPEN"
},
"saturated_resources": {
"description": "name of the saturated resource",
"type": "string",
"example": "STORAGE"
},
"saturated_subresources": {
"description": "name of the saturated subresources",
"type": "string",
"example": "disk"
}
}
}
]
},
"SearchResults": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/PaginationResult"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtendedEvent"
}
}
}
},
"CloseFilter": {
"title": "Close filter request",
"description": "Filter for close.",
"type": "object",
"required": [
"field_name",
"operator",
"values"
],
"properties": {
"field_name": {
"type": "string"
},
"operator": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CloseCondition": {
"title": "Close condition request",
"description": "Join more CloseFilter",
"type": "object",
"required": [
"filters"
],
"properties": {
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CloseFilter"
}
}
}
},
"CloseRequest": {
"type": "object",
"properties": {
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CloseCondition"
}
}
}
},
"CreateEventsRequest": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
},
"UpdateEventRequest": {
"type": "object",
"properties": {
"creation_time": {
"description": "time when the event has happened",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"intervent_time": {
"description": "time when the event has been processed",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"resolution_time": {
"description": "time when the event has been resolved",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"message": {
"description": "the message associated to the event",
"type": "string",
"example": "Host disconnected from cluster"
},
"details": {
"description": "a detailed message",
"type": "string",
"example": "Disconnected from pe-pun-bco-dv05.bmc.com in TSCO-Datastore. Reason: User request"
},
"note": {
"description": "a note associated to the event",
"type": "string",
"example": "Request from user 12345"
},
"event_type": {
"description": "Type of event. Possible values:\n* NOT_PLANNED.INCIDENT\n* PLANNED.GENERIC\n* PLANNED.MAINTENANCE\n* PLANNED.CHANGE\n* NOT_PLANNED.PROBLEM\n* NOT_PLANNED.ERROR\n* UNKNOWN\n* DETECTED\n",
"type": "string",
"pattern": "^(NOT_PLANNED.INCIDENT|PLANNED.GENERIC|PLANNED.MAINTENANCE|PLANNED.CHANGE|NOT_PLANNED.PROBLEM|NOT_PLANNED.ERROR|UNKNOWN|DETECTED)$",
"example": "NOT_PLANNED.INCIDENT"
},
"color": {
"description": "color used for plot the event",
"type": "string",
"example": "#2CAE8B"
},
"period": {
"description": "For repeated events, period in seconds",
"type": "integer",
"format": "int64",
"example": 3600
},
"recurrent_ev_since_time": {
"description": "For repeatable events, start time",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"recurrent_ev_to_time": {
"description": "For repeatable events, end time",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"severity": {
"description": "level of severity",
"type": "string",
"default": "MINOR",
"example": "OK",
"enum": [
"UNKNOWN",
"OK",
"INFO",
"WARNING",
"MINOR",
"MAJOR",
"CRITICAL"
]
},
"service_unavailability": {
"description": "Can cause a service unavailability",
"type": "boolean",
"example": true
},
"source_class": {
"description": "Source class",
"type": "string",
"example": "HOST_STATUS"
},
"occurrences": {
"description": "Count of occurence",
"type": "integer",
"example": 3
},
"state_transition_time": {
"description": "State transition time",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"srcid": {
"description": "ETL that has generated the event",
"type": "integer",
"example": 3
},
"pending_time": {
"description": "Times between creation_time and resolution_time",
"type": "string",
"format": "date-time",
"example": "2020-01-01T00:00:00Z"
},
"entity_id": {
"description": "Entity id related to the event",
"type": "number",
"example": 78945
}
}
}
},
"responses": {
"Unauthorized": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"Forbidden": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"NotFound": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"InternalServerError": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
}