Virima API Specification - ExternalAlertService Services

The requests documented in this section are directed to ExternalAlertService resources, which represent .

Contents

1 editAlert POST Interface
2 configureSenderEmail POST Interface
3 getAllEmailList GET Interface
4 getConfiguredSenderEmail GET Interface
5 saveEmail POST Interface
6 saveAction POST Interface
7 saveMailBoxConfiguration POST Interface
8 saveAlertTemplate POST Interface
9 saveAlerts POST Interface
10 getMailBoxConfiguration GET Interface
11 getAllMailBoxConfiguration GET Interface
12 getNagiosExtractorFileDownloadLink GET Interface

editAlert POST Interface

Method: POST

Relative URL: external-alert/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ExternalAlert

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITALERT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "uniqueId":"?",
   "type":"?",
   "severity":"?",
   "emailList":[
      {
         "title":"?",
         "subject":"?",
         "message":"?",
         "fromEmail":"?",
         "toEmail":"?",
         "startDelimitter":"?",
         "endDelimitter":"?",
         "propertyList":"?",
         "correlator":"?",
         "count":?,
         "duration":?,
         "durationInterval":"?"
      }   ],
   "archive":?,
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

{
   "id":724875805,
   "response":"?"
}

configureSenderEmail POST Interface

Method: POST

Relative URL: external-alert/configure-email

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ValuePojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

CONFIGURESENDEREMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "value":"?",
   "className":"?"
}

Example Response:

{
   "id":1005434706,
   "response":"?"
}

getAllEmailList GET Interface

Method: GET

Relative URL: external-alert/get-all-emaillist/alert-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getConfiguredSenderEmail GET Interface

Method: GET

Relative URL: external-alert/get-configure-email

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveEmail POST Interface

Method: POST

Relative URL: external-alert/save-email/alert-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ExternalAlertEmail

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEEMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "title":"?",
   "subject":"?",
   "message":"?",
   "fromEmail":"?",
   "toEmail":"?",
   "startDelimitter":"?",
   "endDelimitter":"?",
   "propertyList":"?",
   "correlator":"?",
   "count":?,
   "duration":?,
   "durationInterval":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveAction POST Interface

Method: POST

Relative URL: external-alert/save-action

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ExternalAlertAction

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEACTION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "archive":?,
   "enable":?,
   "priority":?,
   "mailBoxConfiguration":"?",
   "actionType":"?",
   "targetModule":"?",
   "targetModel":?,
   "emailList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "ignoreAction":?,
   "ignoreCondition":?,
   "transition":[
      {
         "workflowId":"?",
         "column":"?",
         "value":"?",
         "roleType":"?",
         "mapToProperty":"?",
         "mapped":?,
         "triggered":?,
         "blockId":"?",
         "transitionBlockId":"?"
      }   ],
   "conditions":[
      {
         "workflowId":"?",
         "operator": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "column":"?",
         "value":"?",
         "value1":"?",
         "condition":"?",
         "blockId":"?"
      }   ],
   "cascade":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveMailBoxConfiguration POST Interface

Method: POST

Relative URL: external-alert/save-mail-box-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	MailBoxConfigurationList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEMAILBOXCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "configurationList":[
      {
         "mailBoxName":"?",
         "userName":"?",
         "password":"?",
         "host":"?",
         "port":"?",
         "enableTLS":?,
         "folder":"?",
         "alertType":"?",
         "lastReadOn":?,
         "enableMonitoring":?,
         "monitoringFrequency":?,
         "senderEmail":"?",
         "protocol":"?",
         "useProxy":?,
         "proxyUserName":"?",
         "proxyPassword":"?",
         "proxyHostAddress":"?",
         "proxyPort":"?",
         "archive":?,
         "passwordCheck":?,
         "authenticationType":"?",
         "clientID":"?",
         "tenantID":"?",
         "clientsecret":"?",
         "accessToken":"?",
         "refreshToken":"?",
         "code":"?",
         "redirectURI":"?",
         "clientsecretChanged":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveAlertTemplate POST Interface

Method: POST

Relative URL: external-alert/save-alert-template

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AlertTemplate

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEALERTTEMPLATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "templateName":"?",
   "emailConfiguration": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "content":"?",
   "subjectTemplate":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "uniqueId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveAlerts POST Interface

Method: POST

Relative URL: external-alert/save-alerts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	SavedAlert

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEALERTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "alertName":"?",
   "description":"?",
   "status":"?",
   "ciInfo":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "uniqueId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getMailBoxConfiguration GET Interface

Method: GET

Relative URL: external-alert/get-mail-box-configuration/alert-type

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	MailBoxConfiguration

Example Request:

Example Response:

{
   "id":2147483647,
   "mailBoxName":"?",
   "userName":"?",
   "password":"?",
   "host":"?",
   "port":"?",
   "enableTLS":?,
   "folder":"?",
   "alertType":"?",
   "lastReadOn":?,
   "enableMonitoring":?,
   "monitoringFrequency":?,
   "senderEmail":"?",
   "protocol":"?",
   "useProxy":?,
   "proxyUserName":"?",
   "proxyPassword":"?",
   "proxyHostAddress":"?",
   "proxyPort":"?",
   "archive":?,
   "passwordCheck":?,
   "authenticationType":"?",
   "clientID":"?",
   "tenantID":"?",
   "clientsecret":"?",
   "accessToken":"?",
   "refreshToken":"?",
   "code":"?",
   "redirectURI":"?",
   "clientsecretChanged":?
}

getAllMailBoxConfiguration GET Interface

Method: GET

Relative URL: external-alert/get-all-mail-box-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	MailBoxConfigurationList

Example Request:

Example Response:

{
   "id":1736354889,
   "configurationList":[
      {
         "id":2147483647,
         "mailBoxName":"?",
         "userName":"?",
         "password":"?",
         "host":"?",
         "port":"?",
         "enableTLS":?,
         "folder":"?",
         "alertType":"?",
         "lastReadOn":?,
         "enableMonitoring":?,
         "monitoringFrequency":?,
         "senderEmail":"?",
         "protocol":"?",
         "useProxy":?,
         "proxyUserName":"?",
         "proxyPassword":"?",
         "proxyHostAddress":"?",
         "proxyPort":"?",
         "archive":?,
         "passwordCheck":?,
         "authenticationType":"?",
         "clientID":"?",
         "tenantID":"?",
         "clientsecret":"?",
         "accessToken":"?",
         "refreshToken":"?",
         "code":"?",
         "redirectURI":"?",
         "clientsecretChanged":?
      }   ]
}

getNagiosExtractorFileDownloadLink GET Interface

Method: GET

Relative URL: external-alert/get-nagios-extractor-link

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":690384130,
   "response":"?"
}