Virima API Specification - DiscoveryService Services

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

Contents

1 addRecordDiscovery POST Interface
2 getImageFromS3 GET Interface
3 copyImageFromS3 GET Interface
4 copyImageToBucket GET Interface
5 getExistingImageFromS3 GET Interface
6 getEBSForInstance GET Interface
7 getListenersForLoadBalancer GET Interface
8 getImageForCI GET Interface
9 getBlueprintIcons GET Interface
10 discoveryDataPreprocessor POST Interface
11 invokePattern POST Interface
12 getCIPartNameForBlueprint POST Interface
13 getCMDBDifferences GET Interface
14 getCIPartPropPage POST Interface
15 deleteParentRecDiscovery POST Interface
16 addIgnoreProcess GET Interface
17 getADMIgnoreProcess GET Interface
18 deleteScanHostReport GET Interface
19 deleteAllClients GET Interface
20 deleteAllDiscoveredAssets GET Interface
21 setClientName POST Interface
22 getScanHostReport GET Interface
23 getDiscoveryRecordFromRecordID GET Interface
24 getGroupProbeIDFromName POST Interface
25 addAWSImport POST Interface
26 addScheduledImport POST Interface
27 getScheduledImport GET Interface
28 addAZUREImport POST Interface
29 getDifferenceCount GET Interface
30 cleanCMDBBeforeMove GET Interface
31 getSoftwareVendorListsForDiscoverItem GET Interface
32 getHardwareDetailsForDiscoverItem GET Interface
33 getTinyAgentVersion GET Interface
34 refreshDiscoveryComponent POST Interface
35 getSpiceWorkDB POST Interface
36 editDiscoverPlatformDetectionOrder POST Interface
37 deleteDiscoverPlatformDetectionOrder GET Interface
38 editCredentialConfiguration POST Interface
39 editPaexecConfiguration POST Interface
40 getAllDiscoverPlatformDetectionOrder GET Interface
41 saveOwnerDetails GET Interface
42 saveTagDetails POST Interface
43 getInstalledVirtualMachines GET Interface
44 getVersionAndName GET Interface
45 getVersionAndNameForPackages GET Interface
46 getAllBlueprintsFromDiscovery GET Interface
47 getIgnoreProcessNames GET Interface
48 addADMIgnoreProcess POST Interface
49 addIgnoreProcess POST Interface
50 getDiscoveryItemFromRecordID GET Interface
51 getDiscoveryItemFromInstanceID GET Interface
52 getWarrantyInformation GET Interface
53 getStorageServerUserAccounts GET Interface
54 addMerakiImport POST Interface
55 addIntuneImport POST Interface

addRecordDiscovery POST Interface

Description : It will add data to discovery scan queue table. Scan queue table basically independent from EM table. So data stored in the table based on customer id.

Method: POST

Relative URL: discovery-record/add-record

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
addRecInput	DiscoveryResponse

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

ADDRECORDDISCOVERY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?",
   "scanId":"?",
   "probeId":"?",
   "groupProbeId":"?",
   "host":"?",
   "clientSessionId":"?",
   "recordId":"?",
   "callBackFunction":"?",
   "numberOfUpHosts":"?",
   "matchedCredentialId":"?",
   "blueprint":"?"
}

Example Response:

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

getImageFromS3 GET Interface

Method: GET

Relative URL: discovery-record/get-image/blueprint-id/image-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":"?"
}

copyImageFromS3 GET Interface

Method: GET

Relative URL: discovery-record/copy-image/bucket-name/blueprint-id/image-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":"?"
}

copyImageToBucket GET Interface

Method: GET

Relative URL: discovery-record/copy-image-to-bucket/source-bucket-name/destination-bucket-name/blueprint-id/image-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getExistingImageFromS3 GET Interface

Method: GET

Relative URL: discovery-record/get-existing-image/asset-id/image-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getEBSForInstance GET Interface

Method: GET

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

getImageForCI GET Interface

Method: GET

Relative URL: discovery-record/get-image-for-ci/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":"?"
}

getBlueprintIcons GET Interface

Method: GET

Relative URL: discovery-record/get-blueprint-icons

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

discoveryDataPreprocessor POST Interface

Description : Service to create a preprocessor execution. It takes appropriate javacript from table and run in Rhino JS shell. The function executed as different java thread.

Method: POST

Relative URL: discovery-record/preprocessor

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
data	DiscoveryResponse

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

DISCOVERYDATAPREPROCESSOR 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?",
   "scanId":"?",
   "probeId":"?",
   "groupProbeId":"?",
   "host":"?",
   "clientSessionId":"?",
   "recordId":"?",
   "callBackFunction":"?",
   "numberOfUpHosts":"?",
   "matchedCredentialId":"?",
   "blueprint":"?"
}

Example Response:

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

invokePattern POST Interface

Description : Service to create a trigger pattern execution. It takes all the pattern js from the pattern folder and also user defined pattern and run in Rhino shell. The function executed as different java thread.

Method: POST

Relative URL: discovery-record/invoke-pattern

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
addRecInput	DiscoveryResponse

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

INVOKEPATTERN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?",
   "scanId":"?",
   "probeId":"?",
   "groupProbeId":"?",
   "host":"?",
   "clientSessionId":"?",
   "recordId":"?",
   "callBackFunction":"?",
   "numberOfUpHosts":"?",
   "matchedCredentialId":"?",
   "blueprint":"?"
}

Example Response:

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

getCIPartNameForBlueprint POST Interface

Description : Service for getting all the CI component for the blueprint. Blueprint id need to pass. Response contains ci component as semicolon seperated.

Method: POST

Relative URL: discovery-record/get-ci-part-names

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
blueprintId	ID

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getCMDBDifferences GET Interface

Description : This service will give list of properties which differ in value in discover item record and the same moved record in cmdb.

Method: GET

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

getCIPartPropPage POST Interface

Description : This service gives all the CI part record for the particular parent record. Since pagination has done for this service, we need to pass page number and limit of record per page.

Method: POST

Relative URL: discovery-record/get-ciparts-prop/record-id/scan-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:

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

deleteParentRecDiscovery POST Interface

Description : Service for deleting a discover item record. If the record is parent then it will delete all the child record belongs.

Method: POST

Relative URL: discovery-record/del

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoverItem	DiscoveryIDs

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEPARENTRECDISCOVERY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "recordId":"?",
   "scanID":?
}

Example Response:

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

addIgnoreProcess GET Interface

Description : This service will add unclassified process into ignore list.

Method: GET

Relative URL: discovery-record/add-ignore-process/disc-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":"?"
}

getADMIgnoreProcess GET Interface

Description : This service will add unclassified process into ignore list.

Method: GET

Relative URL: discovery-record/get-ignore-adm-process-names

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

deleteScanHostReport GET Interface

Description : This service will delete a scan host report as per id passing.

Method: GET

Relative URL: discovery-record/delete-scan-host-report/report-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":"?"
}

deleteAllClients GET Interface

Description : This service will delete all CLients (Required for Discovery Test Automation)

Method: GET

Relative URL: discovery-record/delete-all-clients

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

deleteAllDiscoveredAssets GET Interface

Description : This service will delete all Discover Items (Required for Discovery Test Automation)

Method: GET

Relative URL: discovery-record/delete-all-discovered-assets

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

setClientName POST Interface

Description : This service will set Name for Client Which is not Archived (Required for Discovery Test Automation)

Method: POST

Relative URL: discovery-record/set-client-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientName	StringClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getScanHostReport GET Interface

Description : This service will return the scan host report for a ScanID

Method: GET

Relative URL: discovery-record/get-scan-host-report/scan-i-d

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
hostReportList	ScanHostReportArray

Example Request:

Example Response:

{
   "id":2147483647,
   "hostReportList":[
      {
         "id":2147483647,
         "scanId":"?",
         "blueprint":"?",
         "blueprintIcon":"?",
         "recordId":"?",
         "discId":"?",
         "hostIP":"?",
         "result":"?",
         "hostName":"?",
         "reasonDescription":"?",
         "deviceSummary":"?",
         "createdAt":?,
         "beingScanned":?,
         "portScanReport":"?"
      }   ]
}

getDiscoveryRecordFromRecordID GET Interface

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

Method: GET

Relative URL: discovery-record/get-discovery-record-from-record-id/rec-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":"?"
}

getGroupProbeIDFromName POST Interface

Description : This service will getLatest Group probe ID from Name (Required for Discovery Test Automation)

Method: POST

Relative URL: discovery-record/get-group-probe-id-from-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
groupProbeName	StringClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

addAWSImport POST Interface

Description : This service will add AWS Import and get the EC2 data

Method: POST

Relative URL: discovery-record/add-aws-import

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AWSPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDAWSIMPORT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "importedOn":?,
   "importedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "name":"?",
   "credential": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "instances":"?",
   "archive":?,
   "isRecurring":?,
   "accountId":"?",
   "processed":?,
   "importItems":"?",
   "isActive":?,
   "timeZone":"?",
   "importFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "typeOfImport":"?",
   "certificatePath":"?",
   "registryPath":"?",
   "softwareUrl":"?",
   "mssqlDataMappingParameters":"?",
   "mssqlQuery":"?",
   "isHostNamesScan":?,
   "installArguments":"?",
   "blueprintMSSQL":"?"
}

Example Response:

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

addScheduledImport POST Interface

Description : This service will add Scheduled AWS, Azure and Meraki import

Method: POST

Relative URL: discovery-record/add-scheduled-import

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AWSPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDSCHEDULEDIMPORT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "importedOn":?,
   "importedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "name":"?",
   "credential": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "instances":"?",
   "archive":?,
   "isRecurring":?,
   "accountId":"?",
   "processed":?,
   "importItems":"?",
   "isActive":?,
   "timeZone":"?",
   "importFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "typeOfImport":"?",
   "certificatePath":"?",
   "registryPath":"?",
   "softwareUrl":"?",
   "mssqlDataMappingParameters":"?",
   "mssqlQuery":"?",
   "isHostNamesScan":?,
   "installArguments":"?",
   "blueprintMSSQL":"?"
}

Example Response:

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

getScheduledImport GET Interface

Method: GET

Relative URL: discovery-record/get-scheduled-import/type-of-import

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

addAZUREImport POST Interface

Description : This service will take user's azure portal details and import data from azure subscription

Method: POST

Relative URL: discovery-record/add-azure-import

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AZUREPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDAZUREIMPORT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "importedOn":?,
   "importedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "name":"?",
   "credential": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "tenantId":"?",
   "clientId":"?",
   "secretKey":"?",
   "archive":?,
   "subscriptionId":"?",
   "processed":?,
   "importItems":"?"
}

Example Response:

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

getDifferenceCount GET Interface

Description : This service will give number of discover item which are different from cmdb

Method: GET

Relative URL: discovery-record/get-difference-count

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

cleanCMDBBeforeMove GET Interface

Description : This service will clear all CMDB Related Items Before the Automation Move ( For Discovery Automation )

Method: GET

Relative URL: discovery-record/clean-cmdb-before-move

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

getSoftwareVendorListsForDiscoverItem GET Interface

Method: GET

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

getHardwareDetailsForDiscoverItem GET Interface

Method: GET

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

getTinyAgentVersion GET Interface

Method: GET

Relative URL: discovery-record/get-tinyagent-version

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

refreshDiscoveryComponent POST Interface

Method: POST

Relative URL: discovery-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:

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

Example Response:

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

getSpiceWorkDB POST Interface

Method: POST

Relative URL: discovery-record/get-spicework-db

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:

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

Example Response:

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

editDiscoverPlatformDetectionOrder POST Interface

Method: POST

Relative URL: discovery-record/edit-discover-platform-detection-order

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoverPlatform	DiscoverPlatformDetectionOrderList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITDISCOVERPLATFORMDETECTIONORDER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "platformDetectionList":[
      {
         "rank":?,
         "platformType":"?",
         "port":"?"
      }   ]
}

Example Response:

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

deleteDiscoverPlatformDetectionOrder GET Interface

Method: GET

Relative URL: discovery-record/delete-discover-platform-detection-order/discover-platform-detection-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

editCredentialConfiguration POST Interface

Method: POST

Relative URL: discovery-record/edit-credential-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	CredentialConfiguration

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITCREDENTIALCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "windowsDomain":"?",
   "windowsWorkGroup":"?",
   "linux":"?",
   "snmp":"?",
   "scanAgentCheck":?,
   "agentAutoUpdteEnabledFromApp":?,
   "appAutoUpdteEnabledFromServer":?,
   "creationOfAssetBasicNetworkDeviceEnabled":?,
   "scanViaNmapEnabled":?
}

Example Response:

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

editPaexecConfiguration POST Interface

Method: POST

Relative URL: discovery-record/edit-paexec-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	PaexecConfiguration

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITPAEXECCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "argumentList":[
      {
         "argument":"?"
      }   ]
}

Example Response:

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

getAllDiscoverPlatformDetectionOrder GET Interface

Method: GET

Relative URL: discovery-record/get-all-platform-detection-order

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

saveOwnerDetails GET Interface

Method: GET

Relative URL: discovery-record/save-owner-details/discovery-id/owner-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":"?"
}

saveTagDetails POST Interface

Method: POST

Relative URL: discovery-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":2147483647,
   "response":"?"
}

getInstalledVirtualMachines GET Interface

Method: GET

Relative URL: discovery-record/get-installed-virtual-machines/discovery-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: discovery-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":"?"
}

getVersionAndNameForPackages GET Interface

Method: GET

Relative URL: discovery-record/get-ci-version-name-for-packages/parent-id/id/module

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

getAllBlueprintsFromDiscovery GET Interface

Description:

Method: GET

Relative URL: discovery-record/get-all-blueprints-from-discovery

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getIgnoreProcessNames GET Interface

Description:

Method: GET

Relative URL: discovery-record/get-ignore-process-names

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

addADMIgnoreProcess POST Interface

Description:

Method: POST

Relative URL: discovery-record/add-adm-ignore-process

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
data	ValuePojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

addIgnoreProcess POST Interface

Description:

Method: POST

Relative URL: discovery-record/add-ignore-processes

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
data	ValuePojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getDiscoveryItemFromRecordID GET Interface

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

Method: GET

Relative URL: discovery-record/get-discovery-item-from-record-id/rec-i-d/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":"?"
}

getDiscoveryItemFromInstanceID GET Interface

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

Method: GET

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

getWarrantyInformation GET Interface

Method: GET

Relative URL: discovery-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":2147483647,
   "response":"?"
}

getStorageServerUserAccounts GET Interface

Method: GET

Relative URL: discovery-record/get-storage-server-user-accounts/record-id/module

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

addMerakiImport POST Interface

Description : This service will take user's azure portal details and import data from azure subscription

Method: POST

Relative URL: discovery-record/add-meraki-import

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	MerakiPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDMERAKIIMPORT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "importedOn":?,
   "processed":?,
   "archive":?,
   "uniqueId":"?",
   "status":"?",
   "importedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "credential": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

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

addIntuneImport POST Interface

Description : This service will take user's intune portal details and import data from intune

Method: POST

Relative URL: discovery-record/add-intune-import

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	IntunePojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDINTUNEIMPORT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "importedOn":?,
   "importedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "name":"?",
   "credential": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "tenantId":"?",
   "clientId":"?",
   "secretKey":"?",
   "archive":?,
   "processed":?,
   "importItems":"?"
}

Example Response:

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