Virima API Specification - CMDBCIService Services

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

Contents

1 deleteRecord POST Interface
2 deleteLicenseKey POST Interface
3 editValue POST Interface
4 addMaintenance POST Interface
5 getRecordRelation GET Interface
6 saveCIAssetAssociation GET Interface
7 getAllComponentIds GET Interface
8 getRecordRelationWithFilter POST Interface
9 getRecordRelationHierarchical GET Interface
10 getCIDetails GET Interface
11 getAllCIIcons GET Interface
12 editRecordRelation POST Interface
13 addSourceTargetRelation POST Interface
14 addRecordCMDBFromUI POST Interface
15 editChangeAttributes POST Interface
16 moveAllDiscoveredItems POST Interface
17 addPortConfiguration POST Interface
18 moveAllImportedItems POST Interface
19 setDiscoveryProcessing GET Interface
20 setCIProcessing GET Interface
21 setMultipleCIProcessing POST Interface
22 setMultipleDiscoveryProcessing POST Interface
23 deleteCiPart POST Interface
24 deleteAllCiPartRecords POST Interface
25 getCIPartProp POST Interface
26 addPropertyForCI POST Interface
27 addNewPropertyForCI POST Interface
28 addNewProperty POST Interface
29 getAllProperties GET Interface
30 getAllPropertiesWithDataType GET Interface
31 getCount GET Interface
32 getInstalledSystems GET Interface
33 saveBlueprintPic GET Interface
34 saveCIPic GET Interface
35 getAllLicenseKey POST Interface
36 addMoveInThread POST Interface
37 changeEditStatus GET Interface
38 getStatusPossibleValues POST Interface
39 getAssignee POST Interface
40 getManager POST Interface
41 getCI GET Interface
42 getCIWithMainProperties GET Interface
43 getRelationColors GET Interface
44 getConfidenceLevel GET Interface
45 editConfidenceLevel POST Interface
46 addBluePrint POST Interface
47 editRelationShip POST Interface
48 addRelationshipTypes POST Interface
49 editOutage POST Interface
50 createKnowledge GET Interface
51 createSoftwareInstanceRelation GET Interface
52 getUnlinkedSoftwareInstance POST Interface
53 createScanFromCI POST Interface
54 saveClientName POST Interface
55 setScoreThresholds POST Interface
56 getScoreThresholds GET Interface
57 deleteAllRelations POST Interface
58 mergeCI GET Interface
59 getCIPrivateProperties GET Interface
60 getAllFloatingComponents POST Interface
61 associateFloatingComponents POST Interface
62 getAllCisUsingLicenseKey GET Interface
63 getFoldersForVcenter POST Interface
64 getDatacentersForVcenter POST Interface
65 getClustersForVcenter POST Interface
66 getHostsForVcenter POST Interface
67 getTagsForVcenter POST Interface
68 getCIsToAssociateLicenseKey POST Interface
69 getSoftwareVendorListsForCI GET Interface
70 getCmdbRelation GET Interface
71 getBlueprintIdByName GET Interface
72 saveTagDetails POST Interface
73 processIPConnection GET Interface
74 checkADMOrDevOpsProcessing GET Interface
75 getConfigFile POST Interface
76 createRouterToCiRelation GET Interface
77 getVersionAndName GET Interface
78 deleteAllCiPartRecordsJSONType POST Interface
79 saveRelationView POST Interface
80 getAllSavedViews GET Interface
81 getSpecificView GET Interface
82 getADMRelation GET Interface
83 processOSLicenseKeys GET Interface
84 editParentAudit POST Interface
85 editChildAudit POST Interface
86 getAllBlueprintsFromCMDB GET Interface
87 getAllComponentsForSelectedBlueprints POST Interface
88 getAllPropertiesForSelectedBlueprintsAndComponents POST Interface
89 refreshCMDBComponent POST Interface
90 getInstalledParentCIsWithLocation GET Interface
91 getInstalledParentCIs GET Interface
92 getLicenseUsedCIs GET Interface
93 editSoftwareLicenseNotification POST Interface
94 getSoftwareLicenseNotification GET Interface
95 getAllPropertiesForSelectedCIs POST Interface
96 getAllDuplicateCIs POST Interface
97 checkIfUserHasEditAccess POST Interface
98 assignCIRefillTask POST Interface
99 ciTaskReAssignToOwner POST Interface
100 reAssignCIRefillTask POST Interface
101 isCIEditTaskCreated POST Interface
102 saveDriveImage GET Interface
103 addMultipleProperties POST Interface
104 copyFilesBetweenDriveFolders GET Interface
105 editCiExportTemplate POST Interface
106 getTempalteData GET Interface
107 getMigrationCounts GET Interface
108 moveAllRecordsToServiceNow POST Interface
109 getAllPropertiesForBlueprint POST Interface
110 getAllWindowsSecurityPatches GET Interface
111 processAvailablePatchReport GET Interface
112 addSoftwareLicenseKeys POST Interface
113 getSoftwareReport POST Interface
114 getCMDBItemFromRecordID GET Interface
115 getEBSForInstance GET Interface
116 getListenersForLoadBalancer GET Interface
117 getCMDBItemFromInstanceID GET Interface
118 getDownloadableUpdateDetails POST Interface
119 performWindowsUpdateThroughAgent POST Interface
120 getAvailableDotNetHotfixes GET Interface
121 getDownloadableDotNetHotfixes POST Interface
122 performDotNetUpdateThroughAgent POST Interface
123 saveCIContacts POST Interface
124 getUserDetails POST Interface
125 getAllCIContacts GET Interface
126 deleteAllContacts POST Interface
127 getCIDetailsFromAssetId POST Interface
128 getWarrantyInformation GET Interface
129 getAllLicenseKeyForAdvSearch POST Interface
130 cleanArchivedCisFromCMDB GET Interface
131 editSoftwareGroup POST Interface
132 updateLocation POST Interface
133 getMaintainenceInformation GET Interface
134 getAssetCounts GET Interface
135 getSoftwareUsageAndCount GET Interface
136 getDispositionCounts GET Interface
137 getDispositionStatusCounts GET Interface
138 getMoveGroupCounts GET Interface
139 processCloudInstances GET Interface
140 processMissingComponents GET Interface
141 getAzureExtraComponents GET Interface
142 getExtraComponentsById GET Interface
143 getExtraComponentsDetailById GET Interface
144 triggerAwsEcrImageScan GET Interface
145 getExtraComponents GET Interface
146 getKubernetesCred GET Interface
147 getAllCIContracts GET Interface
148 deleteAllContracts POST Interface
149 saveCIContracts POST Interface
150 importSoftwareLicense POST Interface
151 importSoftware POST Interface
152 importCMDBProperties POST Interface
153 abortProcessing GET Interface
154 getCIIds POST Interface

deleteRecord POST Interface

Description: Service to archive selected CI records.

Method: POST

Relative URL: cmdb-ci-record/delete

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deleteRequest	RecordListForDelete

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

DELETERECORD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

deleteLicenseKey POST Interface

Description: Service to disassociate selected CI records.

Method: POST

Relative URL: cmdb-ci-record/delete-license-key

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deleteRequest	RecordListForDelete

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

DELETELICENSEKEY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1470550851,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

editValue POST Interface

Description: Service to update a CI record and store audit record for that CI.

Method: POST

Relative URL: cmdb-ci-record/edit-value

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValueArray	EditValueCmdbArray

Response Structure:

Field Name	Type	Description
record	Record

Example Request:

EDITVALUE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "recordId":"?",
   "blueprint":?,
   "owner":?,
   "group":?,
   "assignee":?,
   "manager":?,
   "licenseGroup":?,
   "location":?,
   "department":?,
   "licenseKey":?,
   "vendor":?,
   "secondLevelSupportUser":?,
   "secondLevelSupportGroup":?,
   "thirdLevelSupportUser":?,
   "thirdLevelSupportGroup":?,
   "hostedOn":?,
   "workflowId":?,
   "loggedInUserId":?,
   "isMultiple":?,
   "tags":"?",
   "tagNames":"?",
   "hardwareAsset":"?",
   "newHardwareAsset":?,
   "warrantyStartDate":"?",
   "warrantyEndDate":"?",
   "fromSync":?,
   "editValue":[
      {
         "id":2147483647,
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

{
   "id":1492788486,
   "recordId":"?",
   "agentName":"?",
   "tags":"?",
   "isNew":"?",
   "isProcessing":?,
   "patternScanRunning":?,
   "isChanged":?,
   "isAWSImport":?,
   "isEditable":?,
   "hasChangeRequest":?,
   "totalRecords":?,
   "diffCount":?,
   "discoveryScanId":?,
   "cmdbId":?,
   "createdOn":?,
   "lastModifiedOn":?,
   "ciIcon":"?",
   "physicalCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "blueprint": {
         "id":2147483647,
         "name":"?",
         "icon":"?",
         "component":?,
         "driveFileId":"?",
         "driveFileId16Px":"?",
         "driveFileId256Px":"?",
         "configureMainPage":"?"
      },
   "parentCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "vendor": {
         "id":1272172273,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "licenseKey": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "owner": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "group": {
         "id":1942806177,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "softwareCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "manager": {
         "id":1377770275,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "department": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "assignee": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "confidenceLevel": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportGroup": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportGroup": {
         "id":2103222508,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "hostedOn": {
         "id":611828405,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "properties":[
      {
         "id":121298265,
         "groupName":"?",
         "propertyName":"?",
         "propertyValue":"?",
         "mandatory":"?",
         "recId":"?",
         "type":"?",
         "propertyStyle":"?",
         "possibleValues":"?",
         "privateProperty":?,
         "groupOrder":?,
         "propertyOrder":?
      }   ],
   "privatePropertyVisibility":?,
   "driveFileId":"?",
   "driveFileId16Px":"?",
   "driveFileId256Px":"?",
   "isTemporaryAccessGiven":?,
   "hardwareAsset": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastSeen":?,
   "missingComponents":?,
   "warrantyStartDate":"?",
   "warrantyEndDate":"?",
   "lastScannedOn":"?",
   "isMoved":"?",
   "cherwellSync":"?",
   "jiraSync":"?",
   "groups":[
      {
         "id":2147483647,
         "groupName":"?",
         "groupOrder":?,
         "archive":?,
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "lastModifiedOn":?,
         "createdOn":?,
         "defaultColumn":?,
         "uniqueId":"?"
      }   ]
}

addMaintenance POST Interface

Description: Service to update a CI record and store audit record for that CI.

Method: POST

Relative URL: cmdb-ci-record/add-maintenance

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
ciMaintenance	CIMaintenance

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

ADDMAINTENANCE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "startDate":?,
   "endDate":?,
   "startTime":"?",
   "endTime":"?",
   "day":"?",
   "timeZone":"?",
   "ciId":"?",
   "archive":?,
   "monthDays":"?",
   "recurrance":"?",
   "NumberOfdays":"?",
   "customerId":"?",
   "userId":"?",
   "client":"?",
   "probe":?,
   "command":"?",
   "isActive":?
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

getRecordRelation GET Interface

Description: Service to get all the relations of the particular CI with other CIs.

Method: GET

Relative URL: cmdb-ci-record/get-relation/record-id/level/view

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
recordRelations	RecordRelationArray

Example Request:

Example Response:

{
   "id":2147483647,
   "recordRelation":[
      {
         "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":251400458,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetOwner": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceLocation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetLocation": {
               "id":350114701,
               "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":1940071957,
               "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":"?"
}

saveCIAssetAssociation GET Interface

Description: Service to create association.

Method: GET

Relative URL: cmdb-ci-record/save-ci-hardware-asset-association/ci-id/asset-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":"?"
}

getAllComponentIds GET Interface

Description: Service to get all the components.

Method: GET

Relative URL: cmdb-ci-record/get-all-component-ids

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

getRecordRelationWithFilter POST Interface

Description: Service to get all the relations of the particular CI with other CIs of specified relationship type.

Method: POST

Relative URL: cmdb-ci-record/get-relation-with-filter/record-id/level

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	StringClass

Response Structure:

Field Name	Type	Description
recordRelations	RecordRelationArray

Example Request:

GETRECORDRELATIONWITHFILTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "stringobj":"?",
   "shortName":"?",
   "s3Name":"?",
   "uniqueId":"?",
   "lineType":"?",
}

Example Response:

{
   "id":308235964,
   "recordRelation":[
      {
         "id":1691529968,
         "groupId":?,
         "source":?,
         "target":?,
         "level":?,
         "sourceName":"?",
         "targetName":"?",
         "sourceBluePrint":"?",
         "targetBluePrint":"?",
         "sourcePort":"?",
         "targetPort":"?",
         "sourceIcon":"?",
         "targetIcon":"?",
         "sourceUnDiscovered":?,
         "targetUnDiscovered":?,
         "sourceAssignee": {
               "id":946364607,
               "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":231110830,
               "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":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceLocation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetLocation": {
               "id":1110249954,
               "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":"?"
}

getRecordRelationHierarchical GET Interface

Description: Service to get all the relations of the particular CI with other CIs in hierarchical view.

Method: GET

Relative URL: cmdb-ci-record/get-relation-hierarchical/record-id/level

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
recordRelations	RecordRelationArray

Example Request:

Example Response:

{
   "id":2147483647,
   "recordRelation":[
      {
         "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":?
      }   ],
   "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":36561779,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetOwner": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "sourceLocation": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetLocation": {
               "id":60152061,
               "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":"?"
}

getCIDetails GET Interface

Description: Service to get minimum details of the ci object for displaying in Map View.

Method: GET

Relative URL: cmdb-ci-record/get-ci-details/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":"?"
}

getAllCIIcons GET Interface

Description:

Method: GET

Relative URL: cmdb-ci-record/get-all-ci-icons

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

editRecordRelation POST Interface

Description: Service to update the relation between CIs.

Method: POST

Relative URL: cmdb-ci-record/edit-relation

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
recordRelation	RecordRelation

Response Structure:

Field Name	Type	Description
message	TransactionMessage

Example Request:

EDITRECORDRELATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "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":?
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

addSourceTargetRelation POST Interface

Description: Service to add relation between CIs.

Method: POST

Relative URL: cmdb-ci-record/add-source-target-relation

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
recordRelationArray	RecordRelationArray

Response Structure:

Field Name	Type	Description
message	TransactionMessage

Example Request:

ADDSOURCETARGETRELATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":692269686,
   "recordRelation":[
      {
         "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":?
      }   ],
   "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":"?"
}

Example Response:

{
   "id":80926837,
   "recordId":"?",
   "message":"?",
   "status":?
}

addRecordCMDBFromUI POST Interface

Description: Service to add CI record and store audit record for that CI.

Method: POST

Relative URL: cmdb-ci-record/add-cmdb/is-ci-part/parent-record-id/comp-name/is-editable

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
record	MultiMap

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

ADDRECORDCMDBFROMUI 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "checkExists":?,
   "workFlowId":?,
   "map":[
      {
         "key":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

editChangeAttributes POST Interface

Description: Service for edit change attributes.

Method: POST

Relative URL: cmdb-ci-record/edit-change-attributes

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
record	MultiMapForCIChangeAttributes

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

EDITCHANGEATTRIBUTES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "checkExists":?,
   "workFlowId":?,
   "map":[
      {
         "key":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "idList":[
      {
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

moveAllDiscoveredItems POST Interface

Description: Service to move all the selected records in discovery to CMDB.

Method: POST

Relative URL: cmdb-ci-record/move-all-records

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

MOVEALLDISCOVEREDITEMS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

addPortConfiguration POST Interface

Method: POST

Relative URL: cmdb-ci-record/add-port-config

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
portConfig	PortConfigurationForProcess

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDPORTCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "process":"?",
   "uniqueId":"?",
   "port":?,
   "relationshipType":?
}

Example Response:

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

moveAllImportedItems POST Interface

Description: Service to move all the selected records from imported file to CMDB.

Method: POST

Relative URL: cmdb-ci-record/move-all-imports

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

MOVEALLIMPORTEDITEMS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

setDiscoveryProcessing GET Interface

Description: Service to mark the discovery item being moved as processing so that it can not be updated while moving.

Method: GET

Relative URL: cmdb-ci-record/set-disc-processing/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":2147483647,
   "response":"?"
}

setCIProcessing GET Interface

Description: Service to mark the imported item being moved as processing so that it can not be updated while moving.

Method: GET

Relative URL: cmdb-ci-record/set-ci-processing/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":2147483647,
   "response":"?"
}

setMultipleCIProcessing POST Interface

Description: Service to mark the imported items being moved as processing so that it can not be updated while moving.

Method: POST

Relative URL: cmdb-ci-record/set-multiple-ci-processing

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	IntegerList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

setMultipleDiscoveryProcessing POST Interface

Description: Service to mark the discovered items being moved as processing so that it can not be updated while moving.

Method: POST

Relative URL: cmdb-ci-record/set-multiple-disc-processing

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	IntegerList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

deleteCiPart POST Interface

Description: Service to archive the component CI.

Method: POST

Relative URL: cmdb-ci-record/del-cipart/parent-record-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	CIPartInput

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

DELETECIPART 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordId":"?",
   "groupName":"?",
   "value":"?",
   "scanId":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

deleteAllCiPartRecords POST Interface

Description: Service to archive the selected component CIs.

Method: POST

Relative URL: cmdb-ci-record/delete-cipart-records

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	DeleteRecordInputs

Response Structure:

Field Name	Type	Description
transactionMeassage	Response

Example Request:

DELETEALLCIPARTRECORDS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordIdList":[
      {
         "recordID":"?"
      }   ],
   "groupName":"?"
}

Example Response:

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

getCIPartProp POST Interface

Description: Service to get all component CIs of this CI.

Method: POST

Relative URL: cmdb-ci-record/get-cipart-prop/record-id/group-name/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterInput	FilterInput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETCIPARTPROP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "module":"?",
   "className":"?",
   "dbClassName":"?",
   "isDashboard":?,
   "snKey":"?",
   "snValue":"?",
   "mainTabSubListSubTab":"?",
   "importType":"?",
   "sort": {
         "sortKey":"?",
         "sortOrder":"?",
         "propertyName":"?",
         "mapProperty":?
      },
   "filters":[
      {
         "display":"?",
         "filterKey":"?",
         "value1":"?",
         "value2":"?",
         "operator":"?",
         "dbPropertyType":"?",
         "mapProperty":?
      }   ]
}

Example Response:

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

addPropertyForCI POST Interface

Description: Service to add existing property to particular blueprint.

Method: POST

Relative URL: cmdb-ci-record/add-property-for-ci

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValueArray	EditValueCmdbArray

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDPROPERTYFORCI 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "recordId":"?",
   "blueprint":?,
   "owner":?,
   "group":?,
   "assignee":?,
   "manager":?,
   "licenseGroup":?,
   "location":?,
   "department":?,
   "licenseKey":?,
   "vendor":?,
   "secondLevelSupportUser":?,
   "secondLevelSupportGroup":?,
   "thirdLevelSupportUser":?,
   "thirdLevelSupportGroup":?,
   "hostedOn":?,
   "workflowId":?,
   "loggedInUserId":?,
   "isMultiple":?,
   "tags":"?",
   "tagNames":"?",
   "hardwareAsset":"?",
   "newHardwareAsset":?,
   "warrantyStartDate":"?",
   "warrantyEndDate":"?",
   "fromSync":?,
   "editValue":[
      {
         "id":2147483647,
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

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

addNewPropertyForCI POST Interface

Description: Service to add new property to CMDB module.

Method: POST

Relative URL: cmdb-ci-record/add-new-property-for-ci

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyDetails	AddNewProperty

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDNEWPROPERTYFORCI 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1865479727,
   "recordId":"?",
   "propertyName":"?",
   "propertyGroupName":"?",
   "dataType":"?",
   "value":"?",
   "mandatory":"?"
}

Example Response:

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

addNewProperty POST Interface

Description: Service to add new property to CMDB module while mapping properties of imported file.

Method: POST

Relative URL: cmdb-ci-record/add-new-property

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyDetails	AddNewProperty

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDNEWPROPERTY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "recordId":"?",
   "propertyName":"?",
   "propertyGroupName":"?",
   "dataType":"?",
   "value":"?",
   "mandatory":"?"
}

Example Response:

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

getAllProperties GET Interface

Description: Service to get all properties of CMDB module. This is useful if we want to add new property to the CMDB module.

Method: GET

Relative URL: cmdb-ci-record/get-all-properties/ciid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getAllPropertiesWithDataType GET Interface

Description: Service to get all properties of CMDB module for particular blueprint with their data types for front-end validations.

Method: GET

Relative URL: cmdb-ci-record/get-properties-with-datatype/blueprint-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getCount GET Interface

Description: Service to get count of all open incidents, requests, changes, problems, or releases associated with this CI.

Method: GET

Relative URL: cmdb-ci-record/get-count/ciid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getInstalledSystems GET Interface

Description: Service to get all the systems where the license keys of this CI is used.

Method: GET

Relative URL: cmdb-ci-record/get-installed-systems/ciid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

saveBlueprintPic GET Interface

Description: Service to get all the systems where the license keys of this CI is used.

Method: GET

Relative URL: cmdb-ci-record/save-blueprint-pic/image-name/blueprint-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

saveCIPic GET Interface

Description: Service to get all the systems where the license keys of this CI is used.

Method: GET

Relative URL: cmdb-ci-record/save-ci-pic/image-name/c-i-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getAllLicenseKey POST Interface

Description: Service to get all the license keys of this Software CI.

Method: POST

Relative URL: cmdb-ci-record/get-all-license-key

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	StringClass

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

GETALLLICENSEKEY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "stringobj":"?",
   "shortName":"?",
   "s3Name":"?",
   "uniqueId":"?",
   "lineType":"?",
}

Example Response:

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

addMoveInThread POST Interface

Description: Service to add selected records for moving into CMDB in a thread.

Method: POST

Relative URL: cmdb-ci-record/add-move-in-thread/is-discovery

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	CIPartInput

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDMOVEINTHREAD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordId":"?",
   "groupName":"?",
   "value":"?",
   "scanId":"?"
}

Example Response:

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

changeEditStatus GET Interface

Description: Service to change the edit status of a CI.

Method: GET

Relative URL: cmdb-ci-record/change-edit-status/ciid/is-editable

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getStatusPossibleValues POST Interface

Description: Service to get status and its approval type.

Method: POST

Relative URL: cmdb-ci-record/get-status-possible-values

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	ValuePojo

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

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

Example Response:

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

getAssignee POST Interface

Description: Service to get list of users with the specified role and who is in the same location as that of CI.

Method: POST

Relative URL: cmdb-ci-record/get-assignee

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
roleSrchInput	RoleSearch

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETASSIGNEE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "role":"?",
   "value":"?",
   "extraCondition": {
         "id":1972297092,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
}

Example Response:

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

getManager POST Interface

Description: Service to get list of users with the role "Configuration Manager".

Method: POST

Relative URL: cmdb-ci-record/get-manager

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
roleSrchInput	RoleSearch

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETMANAGER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "role":"?",
   "value":"?",
   "extraCondition": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
}

Example Response:

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

getCI GET Interface

Description: Service to get particular CI details.

Method: GET

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
record	Record

Example Request:

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "agentName":"?",
   "tags":"?",
   "isNew":"?",
   "isProcessing":?,
   "patternScanRunning":?,
   "isChanged":?,
   "isAWSImport":?,
   "isEditable":?,
   "hasChangeRequest":?,
   "totalRecords":?,
   "diffCount":?,
   "discoveryScanId":?,
   "cmdbId":?,
   "createdOn":?,
   "lastModifiedOn":?,
   "ciIcon":"?",
   "physicalCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "blueprint": {
         "id":2147483647,
         "name":"?",
         "icon":"?",
         "component":?,
         "driveFileId":"?",
         "driveFileId16Px":"?",
         "driveFileId256Px":"?",
         "configureMainPage":"?"
      },
   "parentCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "vendor": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "licenseKey": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "owner": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "group": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "softwareCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "manager": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "location": {
         "id":1192253401,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "department": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "assignee": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "confidenceLevel": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportGroup": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportGroup": {
         "id":710131781,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "hostedOn": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "properties":[
      {
         "id":2039413445,
         "groupName":"?",
         "propertyName":"?",
         "propertyValue":"?",
         "mandatory":"?",
         "recId":"?",
         "type":"?",
         "propertyStyle":"?",
         "possibleValues":"?",
         "privateProperty":?,
         "groupOrder":?,
         "propertyOrder":?
      }   ],
   "privatePropertyVisibility":?,
   "driveFileId":"?",
   "driveFileId16Px":"?",
   "driveFileId256Px":"?",
   "isTemporaryAccessGiven":?,
   "hardwareAsset": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastSeen":?,
   "missingComponents":?,
   "warrantyStartDate":"?",
   "warrantyEndDate":"?",
   "lastScannedOn":"?",
   "isMoved":"?",
   "cherwellSync":"?",
   "jiraSync":"?",
   "groups":[
      {
         "id":1236811185,
         "groupName":"?",
         "groupOrder":?,
         "archive":?,
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2088009628,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "lastModifiedOn":?,
         "createdOn":?,
         "defaultColumn":?,
         "uniqueId":"?"
      }   ]
}

getCIWithMainProperties GET Interface

Description: Service to get particular CI details (only the main properties).

Method: GET

Relative URL: cmdb-ci-record/get-only-main/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
record	Record

Example Request:

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "agentName":"?",
   "tags":"?",
   "isNew":"?",
   "isProcessing":?,
   "patternScanRunning":?,
   "isChanged":?,
   "isAWSImport":?,
   "isEditable":?,
   "hasChangeRequest":?,
   "totalRecords":?,
   "diffCount":?,
   "discoveryScanId":?,
   "cmdbId":?,
   "createdOn":?,
   "lastModifiedOn":?,
   "ciIcon":"?",
   "physicalCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "blueprint": {
         "id":2147483647,
         "name":"?",
         "icon":"?",
         "component":?,
         "driveFileId":"?",
         "driveFileId16Px":"?",
         "driveFileId256Px":"?",
         "configureMainPage":"?"
      },
   "parentCI": {
         "id":374704331,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "vendor": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "licenseKey": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "owner": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "group": {
         "id":1323527955,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "softwareCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "manager": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "department": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "assignee": {
         "id":539789914,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "confidenceLevel": {
         "id":560719617,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportUser": {
         "id":1177495538,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportGroup": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportGroup": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "hostedOn": {
         "id":1887862609,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "properties":[
      {
         "id":2147483647,
         "groupName":"?",
         "propertyName":"?",
         "propertyValue":"?",
         "mandatory":"?",
         "recId":"?",
         "type":"?",
         "propertyStyle":"?",
         "possibleValues":"?",
         "privateProperty":?,
         "groupOrder":?,
         "propertyOrder":?
      }   ],
   "privatePropertyVisibility":?,
   "driveFileId":"?",
   "driveFileId16Px":"?",
   "driveFileId256Px":"?",
   "isTemporaryAccessGiven":?,
   "hardwareAsset": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastSeen":?,
   "missingComponents":?,
   "warrantyStartDate":"?",
   "warrantyEndDate":"?",
   "lastScannedOn":"?",
   "isMoved":"?",
   "cherwellSync":"?",
   "jiraSync":"?",
   "groups":[
      {
         "id":2147483647,
         "groupName":"?",
         "groupOrder":?,
         "archive":?,
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "lastModifiedOn":?,
         "createdOn":?,
         "defaultColumn":?,
         "uniqueId":"?"
      }   ]
}

getRelationColors GET Interface

Description: Service to get all the color legends for relation types.

Method: GET

Relative URL: cmdb-ci-record/get-relation-colors

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

getConfidenceLevel GET Interface

Description: Service to get the Confidence level.

Method: GET

Relative URL: cmdb-ci-record/get-confidence-level

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ConfidenceLevelList

Example Request:

Example Response:

{
   "id":2147483647,
   "confidenceList":[
      {
         "id":2147483647,
         "age":?,
         "confidenceLevel":?,
         "confidenceName":"?"
      }   ]
}

editConfidenceLevel POST Interface

Description: Service to edit Confidence Level.

Method: POST

Relative URL: cmdb-ci-record/edit-confidence-level

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
response	ConfidenceLevelList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITCONFIDENCELEVEL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "confidenceList":[
      {
         "id":2147483647,
         "age":?,
         "confidenceLevel":?,
         "confidenceName":"?"
      }   ]
}

Example Response:

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

addBluePrint POST Interface

Description: Service to add or edit a blueprint.

Method: POST

Relative URL: cmdb-ci-record/edit-blueprint

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
response	BluePrint

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDBLUEPRINT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "icon":"?",
   "workflow":"?",
   "component":?,
   "archive":?,
   "system":?,
   "used":?,
   "version":?,
   "json":?,
   "integrityCheck":?,
   "includes":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "relatedPossibleComponent":[
      {
         "id":2059680483,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "propertyList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "primaryPropertyList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "secretPropertyList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "mainPropertyList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "mandatoryPropertyList":[
      {
         "id":1976470192,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "secretPropertyRoleList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "integrityCheckProperties":[
      {
         "id":34726782,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "lastModifiedBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportGroup": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportGroup": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "driveFileId":"?",
   "driveFileId16Px":"?",
   "driveFileId256Px":"?",
   "tagNames":[
      {
         "id":1501852689,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "configureMainPage":"?",
   "missingComponents":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

editRelationShip POST Interface

Description: Service to edit a relationship.

Method: POST

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
response	RelationshipTypes

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITRELATIONSHIP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "primaryName":"?",
   "reverseName":"?",
   "color":"?",
   "archive":?,
   "system":?,
   "used":?,
   "userTypeRelation":?,
   "lineStroke":"?"
}

Example Response:

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

addRelationshipTypes POST Interface

Description: Service to add relationship types from imported file.

Method: POST

Relative URL: cmdb-ci-record/add-relationship-types

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
relationshipType	ImportRelationshipType

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDRELATIONSHIPTYPES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1582206168,
   "fileName":"?",
   "relationshipTypesList":[
      {
         "id":2147483647,
         "primaryName":"?",
         "reverseName":"?",
         "color":"?",
         "archive":?,
         "system":?,
         "used":?,
         "userTypeRelation":?,
         "lineStroke":"?"
      }   ]
}

Example Response:

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

editOutage POST Interface

Description: Service to edit outage.

Method: POST

Relative URL: cmdb-ci-record/edit-outage

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
response	ChangeCIOutage

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITOUTAGE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "ciId":?,
   "description":"?",
   "outageStart":?,
   "outageEnd":?,
   "ci": {
         "id":1940706123,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "change": {
         "id":863799375,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?
}

Example Response:

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

createKnowledge GET Interface

Method: GET

Relative URL: cmdb-ci-record/create-knowledge/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":"?"
}

createSoftwareInstanceRelation GET Interface

Description: Service to create a Runs On relationship between source and target from front end.

Method: GET

Relative URL: cmdb-ci-record/create-software-instance-relation/source/target

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

getUnlinkedSoftwareInstance POST Interface

Description: Service to create a Runs On relationship between source and target from front end.

Method: POST

Relative URL: cmdb-ci-record/get-unlinked-software-instance

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	StringClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETUNLINKEDSOFTWAREINSTANCE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "stringobj":"?",
   "shortName":"?",
   "s3Name":"?",
   "uniqueId":"?",
   "lineType":"?",
}

Example Response:

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

createScanFromCI POST Interface

Description: Service to create a scan from discovery or cmdb page.

Method: POST

Relative URL: cmdb-ci-record/create-scan-from-ci

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	Rescan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

CREATESCANFROMCI 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":533547280,
   "ipAddress":"?",
   "agentName":"?",
   "typeOfScan":"?",
   "credential":?,
   "ipToRecordIdMap":"?",
   "ports":"?",
   "certificatePath":"?",
   "softwareUrl":"?",
   "installArguments":"?",
   "registryPath":"?",
   "location": {
         "id":1567192861,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

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

saveClientName POST Interface

Description: Service to save user given name for client.

Method: POST

Relative URL: cmdb-ci-record/save-client-name/client-i-d

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	StringClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVECLIENTNAME 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "stringobj":"?",
   "shortName":"?",
   "s3Name":"?",
   "uniqueId":"?",
   "lineType":"?",
}

Example Response:

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

setScoreThresholds POST Interface

Description: Service to add IP connection score thresholds

Method: POST

Relative URL: cmdb-ci-record/set-score-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	IPConnectionScoreThreshold

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SETSCORETHRESHOLDS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1900887206,
   "ipScoreThresholdtype":"?",
   "thresholdValue":?
}

Example Response:

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

getScoreThresholds GET Interface

Description: Service to get IP connection score thresholds

Method: GET

Relative URL: cmdb-ci-record/get-score-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

deleteAllRelations POST Interface

Method: POST

Relative URL: cmdb-ci-record/delete-multiple-relations

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEALLRELATIONS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

mergeCI GET Interface

Method: GET

Relative URL: cmdb-ci-record/merge-ci/source-c-i/destination-c-i

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

getCIPrivateProperties GET Interface

Description: Service to get particular CI's private properties details.

Method: GET

Relative URL: cmdb-ci-record/get-private-properties/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
record	Record

Example Request:

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "agentName":"?",
   "tags":"?",
   "isNew":"?",
   "isProcessing":?,
   "patternScanRunning":?,
   "isChanged":?,
   "isAWSImport":?,
   "isEditable":?,
   "hasChangeRequest":?,
   "totalRecords":?,
   "diffCount":?,
   "discoveryScanId":?,
   "cmdbId":?,
   "createdOn":?,
   "lastModifiedOn":?,
   "ciIcon":"?",
   "physicalCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "blueprint": {
         "id":2147483647,
         "name":"?",
         "icon":"?",
         "component":?,
         "driveFileId":"?",
         "driveFileId16Px":"?",
         "driveFileId256Px":"?",
         "configureMainPage":"?"
      },
   "parentCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "vendor": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "licenseKey": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "owner": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "group": {
         "id":970110342,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "softwareCI": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "manager": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "department": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "assignee": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "confidenceLevel": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportUser": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "secondLevelSupportGroup": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "thirdLevelSupportGroup": {
         "id":1800277138,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "hostedOn": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "properties":[
      {
         "id":2147483647,
         "groupName":"?",
         "propertyName":"?",
         "propertyValue":"?",
         "mandatory":"?",
         "recId":"?",
         "type":"?",
         "propertyStyle":"?",
         "possibleValues":"?",
         "privateProperty":?,
         "groupOrder":?,
         "propertyOrder":?
      }   ],
   "privatePropertyVisibility":?,
   "driveFileId":"?",
   "driveFileId16Px":"?",
   "driveFileId256Px":"?",
   "isTemporaryAccessGiven":?,
   "hardwareAsset": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastSeen":?,
   "missingComponents":?,
   "warrantyStartDate":"?",
   "warrantyEndDate":"?",
   "lastScannedOn":"?",
   "isMoved":"?",
   "cherwellSync":"?",
   "jiraSync":"?",
   "groups":[
      {
         "id":2147483647,
         "groupName":"?",
         "groupOrder":?,
         "archive":?,
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":909406165,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "lastModifiedOn":?,
         "createdOn":?,
         "defaultColumn":?,
         "uniqueId":"?"
      }   ]
}

getAllFloatingComponents POST Interface

Method: POST

Relative URL: cmdb-ci-record/get-all-floating-components/blueprint-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
srchInput	PopupSearch

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETALLFLOATINGCOMPONENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "value":"?",
   "isKnownError":?,
   "isTemplate":?,
   "isCmdbCi":?,
   "extraCondition": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "module":"?"
}

Example Response:

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

associateFloatingComponents POST Interface

Method: POST

Relative URL: cmdb-ci-record/associate-floating-components

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
components	RecordRelationArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ASSOCIATEFLOATINGCOMPONENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1141143744,
   "recordRelation":[
      {
         "id":2147483647,
         "groupId":?,
         "source":?,
         "target":?,
         "level":?,
         "sourceName":"?",
         "targetName":"?",
         "sourceBluePrint":"?",
         "targetBluePrint":"?",
         "sourcePort":"?",
         "targetPort":"?",
         "sourceIcon":"?",
         "targetIcon":"?",
         "sourceUnDiscovered":?,
         "targetUnDiscovered":?,
         "sourceAssignee": {
               "id":1750485275,
               "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":90988847,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "targetLocation": {
               "id":1703694511,
               "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":36212278,
               "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":"?"
}

Example Response:

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

getAllCisUsingLicenseKey GET Interface

Service to get all cis which are using this license key

Method: GET

Relative URL: cmdb-ci-record/get-all-cis-using-licensekey/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":"?"
}

getFoldersForVcenter POST Interface

Service to get all associated folders for a particular vcenter blueprint

Method: POST

Relative URL: cmdb-ci-record/get-folders-for-vcenter/id/limit/page-no

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterSort	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETFOLDERSFORVCENTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

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

getDatacentersForVcenter POST Interface

Service to get all associated datacenters for a particular vcenter blueprint

Method: POST

Relative URL: cmdb-ci-record/get-datacenters-for-vcenter/id/limit/page-no

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterSort	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETDATACENTERSFORVCENTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

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

getClustersForVcenter POST Interface

Service to get all associated clusters for a particular vcenter blueprint

Method: POST

Relative URL: cmdb-ci-record/get-clusters-for-vcenter/id/limit/page-no

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterSort	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETCLUSTERSFORVCENTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

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

getHostsForVcenter POST Interface

Service to get all associated hosts for a particular vcenter blueprint

Method: POST

Relative URL: cmdb-ci-record/get-hosts-for-vcenter/id/limit/page-no

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterSort	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETHOSTSFORVCENTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

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

getTagsForVcenter POST Interface

Service to get all associated tags for a particular vcenter blueprint

Method: POST

Relative URL: cmdb-ci-record/get-tags-for-vcenter/id/limit/page-no

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterSort	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETTAGSFORVCENTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

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

getCIsToAssociateLicenseKey POST Interface

Method: POST

Relative URL: cmdb-ci-record/get-cis-to-associate-license-key/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
stringinput	StringInput

Response Structure:

Field Name	Type	Description
searchList	SearchResult

Example Request:

GETCISTOASSOCIATELICENSEKEY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "bluePrintId":?,
   "searchkey":"?",
   "searchField":"?",
   "ignoreIds":"?",
   "rootCauseCI":?,
   "extraInfo":"?",
   "myCis":?,
   "ownerName":"?"
}

Example Response:

{
   "id":2147483647,
   "SearchList":[
      {
         "id":2147483647,
         "cmdbcid":?,
         "arraysearch":[
            {
               "id":2147483647,
               "blueprintname":"?",
               "assetval":"?",
               "assetId":"?",
               "version":"?",
               "recordId":"?",
               "ciIcon":"?",
               "blueprintIcon":"?",
               "assetName":"?",
               "status":"?",
               "hostName":"?",
               "os":"?",
               "ip":"?"
            }         ]
      }   ],
   "totalRecords":?
}

getSoftwareVendorListsForCI GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-software-vendor-lists/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":"?"
}

getCmdbRelation GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-cmdb-relation/ci-id/ignore-id/type

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	RecordRelationArray

Example Request:

Example Response:

{
   "id":358714032,
   "recordRelation":[
      {
         "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":1616055563,
               "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":?
      }   ],
   "groupedRelation":[
      {
         "id":1579440566,
         "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":967823142,
               "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":"?"
}

getBlueprintIdByName GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-blueprint-id-by-name/name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

saveTagDetails POST Interface

Method: POST

Relative URL: cmdb-ci-record/save-tag-details

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:

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

Example Response:

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

processIPConnection GET Interface

Method: GET

Relative URL: cmdb-ci-record/process-ip-connection/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":"?"
}

checkADMOrDevOpsProcessing GET Interface

Method: GET

Relative URL: cmdb-ci-record/check-is-adm-or-devops-processing

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getConfigFile POST Interface

Method: POST

Relative URL: cmdb-ci-record/get-config-file

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	Rescan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETCONFIGFILE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "ipAddress":"?",
   "agentName":"?",
   "typeOfScan":"?",
   "credential":?,
   "ipToRecordIdMap":"?",
   "ports":"?",
   "certificatePath":"?",
   "softwareUrl":"?",
   "installArguments":"?",
   "registryPath":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

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

createRouterToCiRelation GET Interface

Method: GET

Relative URL: cmdb-ci-record/create-router-to-ci-relation/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":"?"
}

getVersionAndName GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-ci-version-name/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":"?"
}

deleteAllCiPartRecordsJSONType POST Interface

Description: Service to archive the selected component CIs JSON Type.

Method: POST

Relative URL: cmdb-ci-record/delete-cipart-records-json-type

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	DeleteRecordInputs

Response Structure:

Field Name	Type	Description
transactionMeassage	Response

Example Request:

DELETEALLCIPARTRECORDSJSONTYPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordIdList":[
      {
         "recordID":"?"
      }   ],
   "groupName":"?"
}

Example Response:

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

saveRelationView POST Interface

Description: Service to archive selected CI records.

Method: POST

Relative URL: cmdb-ci-record/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":2058922209,
   "rootCi":?,
   "coordinates":"?",
   "treeData":"?",
   "imageData":"?",
   "viewName":"?",
   "savedName":"?"
}

Example Response:

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

getAllSavedViews GET Interface

Description: Service to get all views saved for this ci

Method: GET

Relative URL: cmdb-ci-record/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-record/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":"?"
}

getADMRelation GET Interface

Method: GET

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
recordRelations	RecordRelationArray

Example Request:

Example Response:

{
   "id":2147483647,
   "recordRelation":[
      {
         "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":1738961465,
               "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":2121258283,
               "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":"?"
}

processOSLicenseKeys GET Interface

Method: GET

Relative URL: cmdb-ci-record/process-os-license-keys/start-time/user-id/customer-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":"?"
}

editParentAudit POST Interface

Method: POST

Relative URL: cmdb-ci-record/edit-parent-audit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
audit	CIParentAudits

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITPARENTAUDIT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "name":"?",
   "ci": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "auditor": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "duration":?,
   "nextAuditStatus":"?",
   "nextAuditDueDate":?,
   "currentAuditStatus":"?",
   "currentAuditResult":"?",
   "currentAuditDueDate":?,
   "recurringFrequency":"?",
   "description":"?",
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdOn":?,
   "lastModifiedOn":?,
   "archive":?
}

Example Response:

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

editChildAudit POST Interface

Method: POST

Relative URL: cmdb-ci-record/edit-child-audit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
audit	CIChildAudits

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITCHILDAUDIT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "name":"?",
   "auditStatus":"?",
   "auditResult":"?",
   "auditComments":"?",
   "expectedRecurringDate":?,
   "auditDueDate":?,
   "auditCompletedOn":?,
   "auditor": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "previousAudit": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "parentAudit": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdOn":?,
   "lastModifiedOn":?,
   "s3Name":"?",
   "archive":?
}

Example Response:

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

getAllBlueprintsFromCMDB GET Interface

Description:

Method: GET

Relative URL: cmdb-ci-record/get-all-blueprints-from-cmdb/tag-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":"?"
}

getAllComponentsForSelectedBlueprints POST Interface

Description: get all components for the blueprints selected

Method: POST

Relative URL: cmdb-ci-record/get-all-components-for-selected-blueprints

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETALLCOMPONENTSFORSELECTEDBLUEPRINTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":1488730999,
         "flag":?
      }   ]
}

Example Response:

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

getAllPropertiesForSelectedBlueprintsAndComponents POST Interface

Description: get all properties for the selected blueprint components

Method: POST

Relative URL: cmdb-ci-record/get-all-main-properties-for-selected-blueprints-components

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETALLPROPERTIESFORSELECTEDBLUEPRINTSANDCOMPONENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

refreshCMDBComponent POST Interface

Method: POST

Relative URL: cmdb-ci-record/refresh-discovery-component

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	DiscoveryComponentRefresh

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

REFRESHCMDBCOMPONENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordId":"?",
   "componentName":"?",
   "clientId":"?",
   "ipAddress":"?",
   "extraParameters":"?"
}

Example Response:

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

getInstalledParentCIsWithLocation GET Interface

Description: Service to get all the installed parent CI's.

Method: GET

Relative URL: cmdb-ci-record/get-installed-parent-cis-with-location/ciid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getInstalledParentCIs GET Interface

Description: Service to get all the installed parent CI's.

Method: GET

Relative URL: cmdb-ci-record/get-installed-parent-cis/ciid/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getLicenseUsedCIs GET Interface

Description: Service to get all the systems where the license keys of this CI is used.

Method: GET

Relative URL: cmdb-ci-record/get-license-used-cis/ciid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

editSoftwareLicenseNotification POST Interface

Method: POST

Relative URL: cmdb-ci-record/edit-software-licence-notification

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
softwareLicenceNotification	SoftwareLicenceNotification

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITSOFTWARELICENSENOTIFICATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "sendReportToUsers":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "sendReportToRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "sendReportToGroups":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "sendReportToDepartments":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "noOfDays":?,
   "noOfAvailability":?
}

Example Response:

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

getSoftwareLicenseNotification GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-software-licence-notification

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getAllPropertiesForSelectedCIs POST Interface

Description: Service to get all properties for the selected CI's

Method: POST

Relative URL: cmdb-ci-record/get-all-properties-for-selected-cis

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
recordForChangeAttribute	RecordForChangeAttribute

Example Request:

GETALLPROPERTIESFORSELECTEDCIS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1042110032,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":1658069668,
   "properties":[
      {
         "id":2147483647,
         "groupName":"?",
         "propertyName":"?",
         "propertyValue":"?",
         "mandatory":"?",
         "recId":"?",
         "type":"?",
         "propertyStyle":"?",
         "possibleValues":"?",
         "privateProperty":?,
         "groupOrder":?,
         "propertyOrder":?
      }   ]
}

getAllDuplicateCIs POST Interface

Method: POST

Relative URL: cmdb-ci-record/get-all-duplicate-cis

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyNames	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETALLDUPLICATECIS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "flag":?
      }   ]
}

Example Response:

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

checkIfUserHasEditAccess POST Interface

Method: POST

Relative URL: cmdb-ci-record/check-if-user-has-edit-access

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

CHECKIFUSERHASEDITACCESS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

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

assignCIRefillTask POST Interface

Method: POST

Relative URL: cmdb-ci-record/assign-ci-refill-task

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CIEditTask

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ASSIGNCIREFILLTASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "status":"?",
   "entityId":?,
   "taskValue":"?",
   "dueDate":?,
   "assignee":?,
   "sentItemId":?,
   "uniqueId":"?",
   "allowTemporaryAccess":?,
   "notes":"?"
}

Example Response:

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

ciTaskReAssignToOwner POST Interface

Method: POST

Relative URL: cmdb-ci-record/ci-task-reassign-to-owner

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

CITASKREASSIGNTOOWNER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

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

reAssignCIRefillTask POST Interface

Method: POST

Relative URL: cmdb-ci-record/re-assign-ci-refill-task

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CIEditTask

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

REASSIGNCIREFILLTASK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "status":"?",
   "entityId":?,
   "taskValue":"?",
   "dueDate":?,
   "assignee":?,
   "sentItemId":?,
   "uniqueId":"?",
   "allowTemporaryAccess":?,
   "notes":"?"
}

Example Response:

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

isCIEditTaskCreated POST Interface

Method: POST

Relative URL: cmdb-ci-record/is-edit-task-created

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CIEditTask

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ISCIEDITTASKCREATED 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "status":"?",
   "entityId":?,
   "taskValue":"?",
   "dueDate":?,
   "assignee":?,
   "sentItemId":?,
   "uniqueId":"?",
   "allowTemporaryAccess":?,
   "notes":"?"
}

Example Response:

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

saveDriveImage GET Interface

Description: Service to get all the systems where the license keys of this CI is used.

Method: GET

Relative URL: cmdb-ci-record/save-drive-icon/image-id/image-name/ci-id/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

addMultipleProperties POST Interface

Description: Service to add new property to CMDB module.

Method: POST

Relative URL: cmdb-ci-record/add-multiple-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyDetails	ImportData

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDMULTIPLEPROPERTIES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "fileName":"?",
   "propertyList":[
      {
         "id":2147483647,
         "propertyName":"?",
         "propertyType":"?",
         "propertyGroup":"?",
         "columnName":"?",
         "propertyOrder":?,
         "isMandatory":"?",
         "allblueprints":?,
         "blueprints":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "isMain":"?",
         "isPrivate":"?",
         "isIntegrity":"?",
         "possibleValues":"?",
         "createdOn":?,
         "lastModifiedOn":?,
         "lastModifiedBy": {
               "id":1769654967,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "defaultColumn":"?",
         "isCorrelation":"?",
         "uniqueId":"?",
         "propertyStyle":"?",
         "isMultiple":?,
         "linkTo":"?",
         "isSystem":?
      }   ]
}

Example Response:

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

copyFilesBetweenDriveFolders GET Interface

Description: Service to get all the systems where the license keys of this CI is used.

Method: GET

Relative URL: cmdb-ci-record/copy-file-between-drive-folders/image-id/image-name/ci-id/source-bucket/target-bukcet/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

editCiExportTemplate POST Interface

Method: POST

Relative URL: cmdb-ci-record/edit-ci-export-template

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
exportTemplate	BlueprintPropertyList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITCIEXPORTTEMPLATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "templateName":"?",
   "propertyList":[
      {
         "blueprintId":"?",
      }   ]
}

Example Response:

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

getTempalteData GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-template-data/template-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getMigrationCounts GET Interface

Description: Service to get migration counts

Method: GET

Relative URL: cmdb-ci-record/get-migration-counts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

moveAllRecordsToServiceNow POST Interface

Description: Service to move all the selected records in discovery to Service Now.

Method: POST

Relative URL: cmdb-ci-record/move-all-records-to-service-now

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

MOVEALLRECORDSTOSERVICENOW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

getAllPropertiesForBlueprint POST Interface

Description: Service to get all properties of a blueprint comma separated

Method: POST

Relative URL: cmdb-ci-record/get-properties-string-for-blueprint

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	IntegerList

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

GETALLPROPERTIESFORBLUEPRINT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "actionType":"?",
}

Example Response:

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

getAllWindowsSecurityPatches GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-windows-security-patch/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

processAvailablePatchReport GET Interface

Method: GET

Relative URL: cmdb-ci-record/process-available-patches/start-time/user-id/customer-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

addSoftwareLicenseKeys POST Interface

Method: POST

Relative URL: cmdb-ci-record/add-software-license-key/parent-ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
record	MultiMapList

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

ADDSOFTWARELICENSEKEYS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "map":[
      {
         "checkExists":?,
         "workFlowId":?,
         "map":[
            {
               "key":"?",
               "value":"?",
               "blockId":"?"
            }         ]
      }   ]
}

Example Response:

{
   "id":228677685,
   "recordId":"?",
   "message":"?",
   "status":?
}

getSoftwareReport POST Interface

Method: POST

Relative URL: cmdb-ci-record/get-software-report/ci-id/time-span

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	KeyValue

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETSOFTWAREREPORT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "toDate":?,
   "fromDate":?
}

Example Response:

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

getCMDBItemFromRecordID GET Interface

Description : This service will get cmdb Record from recordID

Method: GET

Relative URL: cmdb-ci-record/get-cmdb-item-from-record-id/rec-i-d/property-name/blueprint

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

getEBSForInstance GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-ebs-for-instance/source-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":"?"
}

getListenersForLoadBalancer GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-listeners-for-load-balancer/source-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":"?"
}

getCMDBItemFromInstanceID GET Interface

Description : This service will get Discovery Record from instance id (Required for Discovery Test Automation)

Method: GET

Relative URL: cmdb-ci-record/get-cmdb-item-from-instance-id/instance-i-d

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

getDownloadableUpdateDetails POST Interface

Method: POST

Relative URL: cmdb-ci-record/get-downloadable-update-details/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	MSWindowsUpdates

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETDOWNLOADABLEUPDATEDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "msWindowsUpdateList":[
      {
         "title":"?",
         "knowledgeBase":"?",
         "supercedence":"?",
         "restartRequired":"?",
         "subtype":"?",
         "severity":"?",
         "url":"?"
      }   ]
}

Example Response:

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

performWindowsUpdateThroughAgent POST Interface

Method: POST

Relative URL: cmdb-ci-record/perform-windows-update-through-agent/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	MSWindowsUpdates

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

PERFORMWINDOWSUPDATETHROUGHAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "msWindowsUpdateList":[
      {
         "title":"?",
         "knowledgeBase":"?",
         "supercedence":"?",
         "restartRequired":"?",
         "subtype":"?",
         "severity":"?",
         "url":"?"
      }   ]
}

Example Response:

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

getAvailableDotNetHotfixes GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-available-dot-net-hotfixes/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getDownloadableDotNetHotfixes POST Interface

Method: POST

Relative URL: cmdb-ci-record/get-downloadable-dot-net-hotfixes/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	MSWindowsUpdates

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETDOWNLOADABLEDOTNETHOTFIXES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "msWindowsUpdateList":[
      {
         "title":"?",
         "knowledgeBase":"?",
         "supercedence":"?",
         "restartRequired":"?",
         "subtype":"?",
         "severity":"?",
         "url":"?"
      }   ]
}

Example Response:

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

performDotNetUpdateThroughAgent POST Interface

Method: POST

Relative URL: cmdb-ci-record/perform-dot-net-update-through-agent/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	MSWindowsUpdates

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

PERFORMDOTNETUPDATETHROUGHAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "msWindowsUpdateList":[
      {
         "title":"?",
         "knowledgeBase":"?",
         "supercedence":"?",
         "restartRequired":"?",
         "subtype":"?",
         "severity":"?",
         "url":"?"
      }   ]
}

Example Response:

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

saveCIContacts POST Interface

Description: service to save ci contact details

Method: POST

Relative URL: cmdb-ci-record/save-ci-contacts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
contacts	CIContacts

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVECICONTACTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ciId":"?",
   "relation":"?",
}

Example Response:

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

getUserDetails POST Interface

Description: service to get ci contact details

Method: POST

Relative URL: cmdb-ci-record/get-user-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
contacts	CIContacts

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETUSERDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ciId":"?",
   "relation":"?",
}

Example Response:

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

getAllCIContacts GET Interface

Description: Service to get all ci contacts

Method: GET

Relative URL: cmdb-ci-record/get-all-ci-contacts/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":"?"
}

deleteAllContacts POST Interface

Method: POST

Relative URL: cmdb-ci-record/delete-multiple-contacts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEALLCONTACTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2116187666,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

getCIDetailsFromAssetId POST Interface

Description: Service to get details of the ci using assetid

Method: POST

Relative URL: cmdb-ci-record/get-ci-details-from-assetid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getWarrantyInformation GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-warranty-info/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllLicenseKeyForAdvSearch POST Interface

Description: Service to get all the license keys of this Software CI.

Method: POST

Relative URL: cmdb-ci-record/get-all-license-key-for-adv-search

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
advSearchInput	AdvancedSearchInput

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

GETALLLICENSEKEYFORADVSEARCH 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "module":"?",
   "className":"?",
   "dbClassName":"?",
   "roleType":"?",
   "extraCondition": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "searchList":[
      {
         "filterKey":"?",
         "value1":"?",
         "value2":"?",
         "operator":"?",
         "dbPropertyType":"?",
         "condition":"?",
         "column":"?"
      }   ],
   "itsmModule":"?"
}

Example Response:

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

cleanArchivedCisFromCMDB GET Interface

Method: GET

Relative URL: cmdb-ci-record/clean-archivedcis-fromcmdb

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

editSoftwareGroup POST Interface

Description: Service to add/edit software group

Method: POST

Relative URL: cmdb-ci-record/edit-software-group

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
softwareLicenseGrp	SoftwareLicenseGroups

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

EDITSOFTWAREGROUP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "vendor": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "uniqueId":"?",
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "licenseKeys": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "createdOn":?
}

Example Response:

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

updateLocation POST Interface

Method: POST

Relative URL: cmdb-ci-record/update-location

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
softwareLicenseGrp	SoftwareLicenseGroups

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

UPDATELOCATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "vendor": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "uniqueId":"?",
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "licenseKeys": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "createdOn":?
}

Example Response:

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

getMaintainenceInformation GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-maintainence-history/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":"?"
}

getAssetCounts GET Interface

Description: Service to get asset counts

Method: GET

Relative URL: cmdb-ci-record/get-asset-counts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getSoftwareUsageAndCount GET Interface

Description: Service to get the software count and usage

Method: GET

Relative URL: cmdb-ci-record/software-usage-count/group-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getDispositionCounts GET Interface

Description: Service to get disposition counts

Method: GET

Relative URL: cmdb-ci-record/get-disposition-counts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getDispositionStatusCounts GET Interface

Description: Service to get disposition status counts

Method: GET

Relative URL: cmdb-ci-record/get-disposition-status-counts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getMoveGroupCounts GET Interface

Description: Service to get move group counts

Method: GET

Relative URL: cmdb-ci-record/get-move-group-counts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

processCloudInstances GET Interface

Method: GET

Relative URL: cmdb-ci-record/process-cloud-instances/start-time/user-id/customer-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":"?"
}

processMissingComponents GET Interface

Method: GET

Relative URL: cmdb-ci-record/process-missing-components/start-time/user-id/customer-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	The response

Example Request:

Example Response:

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

getAzureExtraComponents GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-azure-extra-components/module/recid

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

getExtraComponentsById GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-extra-components-by-id/module/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":"?"
}

getExtraComponentsDetailById GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-extra-components-detail-by-id/module/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":"?"
}

triggerAwsEcrImageScan GET Interface

Method: GET

Relative URL: cmdb-ci-record/trigger-aws-ecr-image-scan/cred-id/list-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":"?"
}

getExtraComponents GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-extra-components/module/recid

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

getKubernetesCred GET Interface

Method: GET

Relative URL: cmdb-ci-record/get-kubernetes-cred/cred-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllCIContracts GET Interface

Description: Service to get all ci contacts

Method: GET

Relative URL: cmdb-ci-record/get-all-ci-contracts/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":"?"
}

deleteAllContracts POST Interface

Method: POST

Relative URL: cmdb-ci-record/delete-multiple-contracts/ci-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEALLCONTRACTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

saveCIContracts POST Interface

Description: service to save ci contact details

Method: POST

Relative URL: cmdb-ci-record/save-ci-contracts

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
contracts	CIContracts

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVECICONTRACTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ciId":"?",
   "contractId":"?",
}

Example Response:

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

importSoftwareLicense POST Interface

Method: POST

Relative URL: cmdb-ci-record/import-software-license

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportCIDetails

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

IMPORTSOFTWARELICENSE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "fileId":?,
   "fileName":"?",
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

{
   "id":1295398481,
   "recordId":"?",
   "message":"?",
   "status":?
}

importSoftware POST Interface

Method: POST

Relative URL: cmdb-ci-record/import-software

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportCIDetails

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

IMPORTSOFTWARE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "fileId":?,
   "fileName":"?",
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

importCMDBProperties POST Interface

Description: Service to import CMDB properties.

Method: POST

Relative URL: cmdb-ci-record/import-cmdb-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportCIDetails

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

IMPORTCMDBPROPERTIES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "fileId":?,
   "fileName":"?",
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

abortProcessing GET Interface

Description : This service will stop the selected Processing for the customer

Method: GET

Relative URL: cmdb-ci-record/abort-processing/process-name

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

getCIIds POST Interface

Method: POST

Relative URL: cmdb-ci-record/get-cis-ids

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	StringClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETCIIDS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "stringobj":"?",
   "shortName":"?",
   "s3Name":"?",
   "uniqueId":"?",
   "lineType":"?",
}

Example Response:

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