Virima API Specification - CMDBCIRelationship Services

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

Contents

1 getRelations POST Interface
2 getNeighbors GET Interface
3 getRelationsADM POST Interface
4 getTinyAgentMap GET Interface
5 getTinyAgentMapDetails GET Interface
6 getDiscoveryAgentMapDetails GET Interface
7 getDiscoveryConnectionMap GET Interface
8 saveRelationView POST Interface
9 getAllSavedViews GET Interface
10 getSpecificView GET Interface
11 getADMConfiguration GET Interface
12 setADMConfiguration POST Interface
13 getIrrelevantViews GET Interface
14 getCIWithOpenIncident GET Interface
15 editRelationshipType POST Interface
16 getSnapShotNames GET Interface
17 getRelationsSnapShot POST Interface

getRelations POST Interface

Description: Service to get CMDB relationship for displaying in Map Views.

Method: POST

Relative URL: cmdb-ci-relationship/get-relations/record-id/level/view-type

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filters	RecordRelationFilter

Response Structure:

Field Name	Type	Description
recordRelations	RecordRelationArray

Example Request:

GETRELATIONS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "groupedIds":"?",
   "networkLevel":"?"
}

Example Response:

{
   "id":2147483647,
   "recordRelation":[
      {
         "id":2147483647,
         "groupId":?,
         "source":?,
         "target":?,
         "level":?,
         "sourceName":"?",
         "targetName":"?",
         "sourceBluePrint":"?",
         "targetBluePrint":"?",
         "sourcePort":"?",
         "targetPort":"?",
         "sourceIcon":"?",
         "targetIcon":"?",
         "sourceUnDiscovered":?,
         "targetUnDiscovered":?,
         "sourceAssignee": {
               "id":1256287416,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetAssignee": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceOwner": {
               "id":864743571,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetOwner": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceLocation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetLocation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceTags":"?",
         "targetTags":"?",
         "sourceIPAddress":"?",
         "targetIPAddress":"?",
         "relation":"?",
         "isExpandable":?,
         "opponentRelations":?,
         "groupedIds":"?",
         "archive":?,
         "dbName":"?",
         "sourceOpenIncidents":?,
         "targetOpenIncidents":?,
         "sourceOpenChanges":?,
         "targetOpenChanges":?,
         "sourceClosedChanges":?,
         "targetClosedChanges":?,
         "streamDirection":"?",
         "isCiUp":?,
         "isTargetUp":?,
         "isImpacted":?,
         "sourceVulnerable":"?",
         "targetVulnerable":"?",
         "sourceRegion":"?",
         "targetRegion":"?",
         "protocol":"?",
         "isMainCiUp":?
      }   ],
   "groupedRelation":[
      {
         "id":2147483647,
         "groupId":?,
         "source":?,
         "target":?,
         "level":?,
         "sourceName":"?",
         "targetName":"?",
         "sourceBluePrint":"?",
         "targetBluePrint":"?",
         "sourcePort":"?",
         "targetPort":"?",
         "sourceIcon":"?",
         "targetIcon":"?",
         "sourceUnDiscovered":?,
         "targetUnDiscovered":?,
         "sourceAssignee": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetAssignee": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceOwner": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetOwner": {
               "id":1071604239,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceLocation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetLocation": {
               "id":335344361,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceTags":"?",
         "targetTags":"?",
         "sourceIPAddress":"?",
         "targetIPAddress":"?",
         "relation":"?",
         "isExpandable":?,
         "opponentRelations":?,
         "groupedIds":"?",
         "archive":?,
         "dbName":"?",
         "sourceOpenIncidents":?,
         "targetOpenIncidents":?,
         "sourceOpenChanges":?,
         "targetOpenChanges":?,
         "sourceClosedChanges":?,
         "targetClosedChanges":?,
         "streamDirection":"?",
         "isCiUp":?,
         "isTargetUp":?,
         "isImpacted":?,
         "sourceVulnerable":"?",
         "targetVulnerable":"?",
         "sourceRegion":"?",
         "targetRegion":"?",
         "protocol":"?",
         "isMainCiUp":?
      }   ],
   "lastGroupedIndex":?,
   "customerId":"?",
   "userId":"?",
   "extraValue":"?"
}

getNeighbors GET Interface

Description: Get Neighbor devices of the Switch or Router device.

Method: GET

Relative URL: cmdb-ci-relationship/get-neighbors/record-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getRelationsADM POST Interface

Description: Service to get CMDB relationship for displaying in ADM Views.

Method: POST

Relative URL: cmdb-ci-relationship/get-relations-adm/record-id/level

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filters	RecordRelationFilter

Response Structure:

Field Name	Type	Description
recordRelations	RecordRelationArray

Example Request:

GETRELATIONSADM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "groupedIds":"?",
   "networkLevel":"?"
}

Example Response:

{
   "id":2147483647,
   "recordRelation":[
      {
         "id":2147483647,
         "groupId":?,
         "source":?,
         "target":?,
         "level":?,
         "sourceName":"?",
         "targetName":"?",
         "sourceBluePrint":"?",
         "targetBluePrint":"?",
         "sourcePort":"?",
         "targetPort":"?",
         "sourceIcon":"?",
         "targetIcon":"?",
         "sourceUnDiscovered":?,
         "targetUnDiscovered":?,
         "sourceAssignee": {
               "id":2105831197,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetAssignee": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceOwner": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetOwner": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceLocation": {
               "id":1791894724,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetLocation": {
               "id":844919169,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceTags":"?",
         "targetTags":"?",
         "sourceIPAddress":"?",
         "targetIPAddress":"?",
         "relation":"?",
         "isExpandable":?,
         "opponentRelations":?,
         "groupedIds":"?",
         "archive":?,
         "dbName":"?",
         "sourceOpenIncidents":?,
         "targetOpenIncidents":?,
         "sourceOpenChanges":?,
         "targetOpenChanges":?,
         "sourceClosedChanges":?,
         "targetClosedChanges":?,
         "streamDirection":"?",
         "isCiUp":?,
         "isTargetUp":?,
         "isImpacted":?,
         "sourceVulnerable":"?",
         "targetVulnerable":"?",
         "sourceRegion":"?",
         "targetRegion":"?",
         "protocol":"?",
         "isMainCiUp":?
      }   ],
   "groupedRelation":[
      {
         "id":2147483647,
         "groupId":?,
         "source":?,
         "target":?,
         "level":?,
         "sourceName":"?",
         "targetName":"?",
         "sourceBluePrint":"?",
         "targetBluePrint":"?",
         "sourcePort":"?",
         "targetPort":"?",
         "sourceIcon":"?",
         "targetIcon":"?",
         "sourceUnDiscovered":?,
         "targetUnDiscovered":?,
         "sourceAssignee": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetAssignee": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceOwner": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetOwner": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceLocation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetLocation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceTags":"?",
         "targetTags":"?",
         "sourceIPAddress":"?",
         "targetIPAddress":"?",
         "relation":"?",
         "isExpandable":?,
         "opponentRelations":?,
         "groupedIds":"?",
         "archive":?,
         "dbName":"?",
         "sourceOpenIncidents":?,
         "targetOpenIncidents":?,
         "sourceOpenChanges":?,
         "targetOpenChanges":?,
         "sourceClosedChanges":?,
         "targetClosedChanges":?,
         "streamDirection":"?",
         "isCiUp":?,
         "isTargetUp":?,
         "isImpacted":?,
         "sourceVulnerable":"?",
         "targetVulnerable":"?",
         "sourceRegion":"?",
         "targetRegion":"?",
         "protocol":"?",
         "isMainCiUp":?
      }   ],
   "lastGroupedIndex":?,
   "customerId":"?",
   "userId":"?",
   "extraValue":"?"
}

getTinyAgentMap GET Interface

Method: GET

Relative URL: cmdb-ci-relationship/get-tiny-agent-map/client-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":"?"
}

getTinyAgentMapDetails GET Interface

Description: Service to get details of tiny agent or client in Map View.

Method: GET

Relative URL: cmdb-ci-relationship/get-tiny-agent-map-details/id/type

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

getDiscoveryAgentMapDetails GET Interface

Description: Service to get details of tiny agent or client in Map View.

Method: GET

Relative URL: cmdb-ci-relationship/get-discovery-agent-map-details/id/type

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

getDiscoveryConnectionMap GET Interface

Gives the overview map about all the discovery application which is running on customer inventory.

Method: GET

Relative URL: cmdb-ci-relationship/get-discovery-connection-map

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

saveRelationView POST Interface

Description: Service to archive selected CI records.

Method: POST

Relative URL: cmdb-ci-relationship/save-view

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
viewDetails	SaveRelationView

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVERELATIONVIEW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "rootCi":?,
   "coordinates":"?",
   "treeData":"?",
   "imageData":"?",
   "viewName":"?",
   "savedName":"?"
}

Example Response:

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

getAllSavedViews GET Interface

Description: Service to get all views saved for this root id

Method: GET

Relative URL: cmdb-ci-relationship/get-all-saved-views/root-ci/view

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

getSpecificView GET Interface

Description: Get the specific view coordinates

Method: GET

Relative URL: cmdb-ci-relationship/get-specific-view/view-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":"?"
}

getADMConfiguration GET Interface

Description: Get the specific view coordinates

Method: GET

Relative URL: cmdb-ci-relationship/get-adm-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ADMConfiguration

Example Request:

Example Response:

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

setADMConfiguration POST Interface

Description: Get the specific view coordinates

Method: POST

Relative URL: cmdb-ci-relationship/set-adm-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
admConfiguration	ADMConfiguration

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SETADMCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "configurationDetails":"?"
}

Example Response:

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

getIrrelevantViews GET Interface

Description: Check if some views are irrelevant for a ci; for eg: for parent CI's ADM View doesn't make sense.

Method: GET

Relative URL: cmdb-ci-relationship/get-irrelevant-views/ci-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":"?"
}

getCIWithOpenIncident GET Interface

Description: Check if some views are irrelevant for a ci; for eg: for parent CI's ADM View doesn't make sense.

Method: GET

Relative URL: cmdb-ci-relationship/get-ci-with-open-incidents/ci-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":"?"
}

editRelationshipType POST Interface

Description: Service to edit relation ship type between two CIs

Method: POST

Relative URL: cmdb-ci-relationship/edit-relationship-type

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	EditCIRelationshipType

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITRELATIONSHIPTYPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":570580194,
   "source":?,
   "target":?,
   "oldRelation":"?",
   "newRelation":"?",
   "action":"?",
   "actualId":"?"
}

Example Response:

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

getSnapShotNames GET Interface

Description: Service to get snapshot names for a particular ci

Method: GET

Relative URL: cmdb-ci-relationship/get-snapshot-names/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
output	Response

Example Request:

Example Response:

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

getRelationsSnapShot POST Interface

Description: Service to get CMDB relationship for displaying in Map Views.

Method: POST

Relative URL: cmdb-ci-relationship/get-relations-snapshot/snap-shot-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filters	RecordRelationFilter

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETRELATIONSSNAPSHOT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "groupedIds":"?",
   "networkLevel":"?"
}

Example Response:

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