Alert Export API Response
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$id": "http://example.com/example.json",
"type": "object",
"title": "The root schema",
"description": "The root schema comprises the entire JSON document.",
"default": {},
"examples": [
{
"id": "11780648",
"createdTime": "2023-05-23T13:39:11+0000",
"clientId": "rt9a96d4-8ab1-4a87-bgf8-98706vn1f58c",
"clientName": "ITS Client",
"alertType": "Monitoring",
"source": "OpsRamp",
"isAvailabilityAlert": false,
"component": "status",
"currentState": "Ok",
"originalState" : "Critical",
"previousState" :"Critical",
"objectId": "50917343-z6c2-4s45-bre10-b1b4944d5f8e",
"objectName" : "nexgen-gw",
"objectType" : "RESOURCE",
"ipAddress" : "172.31.60.52",
"dnsName" : "nexgen-gw",
"eventType": "ALERT",
"isInferenceAlert": false,
"inferenceId": 0,
"version" : 0,
"metric": "Tunnel Status",
"monitorName": "Tunnel Status",
"partnerId" : "ed0d-srws-4sdf-gasd-40cc-b117-63890a3cc9cc",
"partnerName": "SQALab",
"priority": "",
"alertCriticalWarningDuration" : "105135",
"problemArea": "Tunnel Status",
"repeatCount": "11",
"processIds" : [],
"clientServiceName" :[],
"elapsedTime" :"",
"snoozeDuration": 0,
"origin" : "",
"resourceMaintenanceWindowId" : "",
"status": "New",
"observedMode" : false,
"incidentId" : "INC0001550"
"statusHistory": {
"ticketedBy" : "opsramp_system_user",
"ticketedTime" : "2023-05-24T05:20:24+0000",
"openBy" :"system",
"openTime" : "2023-05-24T05:20:23+0000"
},
"events" : [{ "id" : "d0c02ca6-36f3-46d1-96b7-13f0re937156"}],
"tags" : [
{
"name" : "host",
"value" : "ip-172-31-63-53"
},
{
"name" : "resourceUUID",
"value" : "50917343-z6c2-4s45-bre10-b1b4944d5f8e"
}],
"subject": "OpsRamp gateway is offline",
"description" : "OpsRamp gateway is offline<br><br><b>Impacted Resources:</b> The availability state of the resources managed by the Gateway will be affected due to this alert. Click <a href="/portal/infra-ui/resources?query=managementProfileId='3'" target="_blank">here</a> to know the impacted resources",
"comments" : "[]",
"updatedTime": "2021-05-23T16:44:40+0000",
"createdBy" : "system",
"updatedBy" : "system",
"nocId": 3,
"nocName": "QA NOC1",
"uuid":"39254808",
"triggeredTime":"2023-07-04T20:41:14+0000",
"clientUuId":"8cf20820-d38c-c472-8287-a51f3a46c7d4"
}
],
"required": [
"alertCriticalWarningDuration",
"alertType",
"clientId",
"clientName",
"clientServiceName",
"clientUuId",
"component",
"createdBy",
"createdTime",
"currentState",
"customFields",
"description",
"elapsedTime",
"eventType",
"id",
"inferenceId",
"ipAddress",
"isAvailabilityAlert",
"isInferenceAlert",
"metric",
"nocId",
"nocName"
"objectId",
"objectName",
"objectType",
"origin",
"originalState",
"partnerId",
"partnerName",
"problemArea",
"processIds",
"repeatCount",
"resourceMaintenanceWindowId",
"snoozeDuration",
"source",
"status",
"statusHistory",
"subject",
"triggeredTime",
"updatedBy",
"updatedTime",
"uuid",
"version"
],
"properties": {
"alertCriticalWarningDuration": {
"type": "integer"
},
"isAvailabilityAlert": {
"type": "boolean"
},
"clientName": {
"type": "string"
},
"subject": {
"type": "string"
},
"customFields": {
"type": "array",
"items": {}
},
"inferenceId": {
"type": "integer"
},
"origin": {
"type": "string"
},
"description": {
"type": "string"
},
"source": {
"type": "string"
},
"objectType": {
"type": "string"
},
"resourceMaintenanceWindowId": {
"type": "string"
},
"createdTime": {
"type": "string"
},
"id": {
"type": "integer"
},
"isInferenceAlert": {
"type": "boolean"
},
"objectId": {
"type": "string",
"format": "uuid"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"repeatCount": {
"type": "integer"
},
"processIds": {
"type": "array",
"items": {}
},
"updatedTime": {
"type": "string"
},
"alertType": {
"type": "string"
},
"clientId": {
"type": "string",
"format": "uuid"
},
"updatedBy": {
"type": "string"
},
"comments": {
"type": "array",
"items": {
"type": "string"
}
},
"partnerName": {
"type": "string"
},
"monitorName": {
"type": "string"
},
"snoozeDuration": {
"type": "integer"
},
"originalState": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"eventType": {
"type": "string"
},
"version": {
"type": "integer"
},
"clientServiceName": {
"type": "array",
"items": {}
},
"previousState": {
"type": "string"
},
"component": {
"type": "string"
},
"metric": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"problemArea": {
"type": "string"
},
"objectName": {
"type": "string"
},
"partnerId": {
"type": "string",
"format": "uuid"
},
"currentState": {
"type": "string"
},
"status": {
"type": "string"
},
"elapsedTime": {
"type": "string"
},
"incidentId": {
"type": "string"
},
"prcId": {
"type": "string",
"format": "uuid"
},
"observedMode": {
"type": "boolean"
},
"dnsName": {
"type": "string"
},
"events": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"id"
],
"title": "events"
},
"statusHistory": {
"type": "object",
"properties": {
"openBy": {
"type": "string"
},
"openTime": {
"type": "string"
},
"ticketedBy": {
"type": "string"
},
"ticketedTime": {
"type": "string"
}
},
"required": [
"openBy",
"openTime"
],
"title": "statusHistory"
},
"tags": {
"type": "object",
"properties": {
"name": {
"type: "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "tags"
},
"clientName": {
"type": "string",
"enum": [
"ITS Client"
],
"title": "clientName"
},
"eventType": {
"type": "string",
"enum": [
"ALERT"
],
"title": "eventType"
},
"ObjectType": {
"type": "string",
"enum": [
"RESOURCE"
],
"title": "ObjectType"
},
"partnerName": {
"type": "string",
"enum": [
"SQALab"
],
"title": "partnerName"
},
"source": {
"type": "string",
"enum": [
"OpsRamp"
],
"title": "source"
},
"status": {
"type": "string",
"enum": [
"Open",
"Acknowledged",
"Ticketed",
"Suppressed",
"Closed",
"Correlated"
],
"title": "status"
},
"nocId": {
"type": "integer"
},
"nocName": {
"type": "string"
},
"uuid": {
"type": "string",
"format": "integer"
},
"clientUuId": {
"type": "string",
"format": "uuid"
},
"triggeredTime": {
"type": "string"
}
}Old API Response vs New API Response
Following are the comparison between old Alert Batch Export API vs New API Response:
| Old API | New API | ||
|---|---|---|---|
| Alert Attributes | API Response | Alert Attributes | API Response |
| uniqueId | 33443987 | id | 33443987 |
| subject | Change is Detected on system.cpu.stats.total | subject | Change is Detected on system.cpu.stats.total |
| currentState | Ok | currentState | Ok |
| serviceName | system.cpu.stats.total | metric | system.cpu.stats.total |
| problemArea | system.cpu.stats.total | problemArea | system.cpu.stats.total |
| acknowledged | FALSE | Status | Open |
| suppressed | FALSE | Acknowledged | |
| permanentlySuppressed | FALSE | Suppressed | |
| closed | FALSE | Closed | |
| ticketed | FALSE | -Ticketed | |
| status | Ticketed | Correlated | clientUniqueId | client_25 | clientId | client_25 | alertType | Monitoring | alertType | MONITORING |
| app | OpsRamp | source | OpsRamp |
| component | component | ||
| alertTime | 2022-05-31T14:43:00+0000 | createdTime | 2022-05-31T14:43:00+0000 |
| repeatCount | 2 | repeatCount | 2 |
| tenantId | 25 | tenantUniqueId | client_25 |
| createdTime: | 2022-05-31T14:43:00+0000 | createdTime: | 2022-05-31T14:43:00+0000 |
| priority | N/A | priority | null |
| elapsedTimeString | 17d 9h 43m | elapsedTime | "" |
| healedTimeString | 14m | alertCriticalWarning Duration | 25677 |
| updatedTime | 2022-05-31T14:57:39+0000 | updatedTime | 2022-05-31T14:57:39+0000 |
| tktId | ticket_407543 | incidentId | INC00004072 |
| rba | FALSE | N/A | |
| tenantName | IT CLIENT | clientName | IT CLIENT |
| rtype | RESOURCE | objectType | RESOURCE |
| entityType | RESOURCE | objectType | RESOURCE |
| mspId | msp_21 | partnerId | 77dsfdf34c-2a8f-34-e79b-f8805c5af963 |
| mspName | Agent | partnerName | Agent |
| resourceId | 100321 | objectId | 5gadda47-c346-41fc-ba90-e471a4203c6e |
| resourceName | qa-srs-ubuntu | objectName | qa-srs-ubuntu |
| managedByOpsRamp | TRUE | N/A | |
| actedTs | 1654008197928 | N/A | |
| metricTime | 0 | N/A | |
| eventType | INFERENCE | eventType | INFERENCE |
| inferenceId | 0 | inferenceId | 0 |
| snoozeDuration | 0 | snoozeDuration | 0 |
| metric | system.cpu.stats.total | metric | system.cpu.stats.total |
| inferenceAlert | TRUE | isInferenceAlert | TRUE |
| statusHistory | "{ createdBy: system createdTime: 2022-05-31T14:43:03+0000 ticketedBy: opsramp_system_user ticketedTime: 2022-05-31T14:43:17+0000 }" | statusHistory | "{ openBy : system openTime : 2022-05-31T14:43:03+0000 ticketedBy : opsramp_system_user ticketedTime : 2022-05-31T14:43:17+0000 }" |
| device | "{ id: 5e0dda47-c346-41fc-ba70-e471a4203c6e name: qa-srs-ubuntu ipAddress: 172.14.21.62 type: DEVICE }" | Provided All fields individually | " objectId: 587GFDda47-c346-41fc-ba70-e471a4203c6e objectName: qa-srs-ubuntu ipAddress: 172.14.21.62 objectType: DEVICE" |
| customFields | [] | customFields | [] |
| N/A | isAvailabilityAlert | FALSE | |
| N/A | origin | ||
| N/A | description | Change is Detected on system.cpu.stats.total | |
| N/A | resourceMaintenance WindowId | "" | |
| N/A | processIds | [] | |
| N/A | updatedBy | system | |
| N/A | comments | [] | |
| N/A | monitorName | Total Status | |
| N/A | originalState | Critical | |
| N/A | version | 0 | |
| N/A | clientServiceName | [] | |
| N/A | previousState | Critical | |
| N/A | createdBy | system | |
| N/A | tags | [{name : "host", value: "qa-srs-ubuntu"}] | |