Virima API Specification - CorrelationService Services

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

Contents

1 getCorrelationRules POST Interface
2 getCorrelatedDataMap POST Interface
3 getAllCorrelation GET Interface
4 addCorrelationRule POST Interface
5 getBlueprintProperties GET Interface
6 getAgentCorrelator GET Interface
7 addAgentCorrelator POST Interface

getCorrelationRules POST Interface

Description: Service for getting correlation rules.

Method: POST

Relative URL: correlation-service/get-correlation-rules

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CorrelationInput

Response Structure:

Field Name	Type	Description
response	CorrelationArrayList

Example Request:

GETCORRELATIONRULES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "blueprintName":"?",
   "propertyValues":"?"
}

Example Response:

{
   "id":2147483647,
}

getCorrelatedDataMap POST Interface

Description: Service for getting correlation rules.

Method: POST

Relative URL: correlation-service/get-correlated-map

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CorrelationInput

Response Structure:

Field Name	Type	Description
response	CorrelationInput

Example Request:

GETCORRELATEDDATAMAP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "blueprintName":"?",
   "propertyValues":"?"
}

Example Response:

{
   "id":2147483647,
   "blueprintName":"?",
   "propertyValues":"?"
}

getAllCorrelation GET Interface

Description: Service for getting all correlation rules for UI.

Method: GET

Relative URL: correlation-service/getall

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	CorrelationRuleArray

Example Request:

Example Response:

{
   "id":2147483647,
   "rulesList":[
      {
         "id":2060640317,
         "blueprintName":"?",
         "blueprintID":?,
         "rules":[
            {
               "id":2147483647,
               "priority":?
            }         ]
      }   ]
}

addCorrelationRule POST Interface

Description: Service for getting all correlation rules for UI.

Method: POST

Relative URL: correlation-service/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CorrelationRuleInputList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDCORRELATIONRULE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "properties":[
      {
         "id":897408623,
         "blueprint":"?",
         "property":?,
         "priority":?,
         "delete":?
      }   ],
   "agentCorrelatorProperties":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

getBlueprintProperties GET Interface

Description: Service for getting all correlation rules for UI.

Method: GET

Relative URL: correlation-service/get-blueprints

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":"?"
}

getAgentCorrelator GET Interface

Description: Service for getting Agent Correlation rule

Method: GET

Relative URL: correlation-service/get-agent-correlator

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":"?"
}

addAgentCorrelator POST Interface

Description: Service for Adding Agent Correlation rule

Method: POST

Relative URL: correlation-service/add-agent-correlator

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AgentCorrelator

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDAGENTCORRELATOR 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "correlatorProperty":[
      {
         "id":153224694,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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