|
|
Virima API Specification - AndroidService Services
The requests documented in this section are directed to
AndroidService resources, which represent .
getAllCisWithMinimalValues POST Interface
Method: POST Relative URL: android-service/get-all-cis-with-minimal-values Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLCISWITHMINIMALVALUES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllImportedFromAwsWithMinimalValues POST Interface
Method: POST Relative URL: android-service/get-all-importedfromaws-with-minimal-values Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLIMPORTEDFROMAWSWITHMINIMALVALUES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllImportedFromAzureWithMinimalValues POST Interface
Method: POST Relative URL: android-service/get-all-importedfromazure-with-minimal-values Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLIMPORTEDFROMAZUREWITHMINIMALVALUES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":588242063,
"response":"?"
}
getAllHOstScanReport POST Interface
Method: POST Relative URL: android-service/get-all-host-scan-report Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLHOSTSCANREPORT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":608547946,
"response":"?"
}
getAllDIscoveredItemssWithMinimalValues POST Interface
Method: POST Relative URL: android-service/get-all-discovereditems-with-minimal-values Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLDISCOVEREDITEMSSWITHMINIMALVALUES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllScansWithMinimalValues POST Interface
Method: POST Relative URL: android-service/get-all-scans-with-minimal-values Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLSCANSWITHMINIMALVALUES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
addMobileDeviceData POST Interface
Method: POST Relative URL: android-service/add-mobile-device-data Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | MobileManagement | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: ADDMOBILEDEVICEDATA
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"userId":"?",
"serialNumber":"?",
"brand":"?",
"model":"?",
"board":"?",
"manufacture":"?",
"internalAvailableMemory":"?",
"buildId":"?",
"sdk":"?",
"macAddress":"?",
"androidId":"?",
"internalTotalMemory":"?",
"host":"?",
"totalMemory":"?",
"availableMemory":"?",
"fingerPrint":"?",
"imeiNumber":"?",
"versionCode":"?"
}
Example Response: {
"id":1164572328,
"response":"?"
}
getDefaultPropForCiPart POST Interface
Method: POST Relative URL: android-service/get-default-prop--cipart/component-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| propertyList | CompValueList | |
Example Request: GETDEFAULTPROPFORCIPART
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"StringList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"mandatory":"?"
} ]
}
changeEditStatus POST Interface
Description:
Service to change the edit status of a CI.
Method: POST Relative URL: android-service/change-edit-status/ciid/is-editable Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: CHANGEEDITSTATUS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
editValue POST Interface
Description:
Service to update a CI record and store audit record for that CI.
Method: POST Relative URL: android-service/edit-value Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| editValueArray | EditValueCmdbArrayAndroid | |
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":?,
"location":?,
"department":?,
"licenseKey":?,
"vendor":?,
"secondLevelSupportUser":?,
"secondLevelSupportGroup":?,
"thirdLevelSupportUser":?,
"thirdLevelSupportGroup":?,
"hostedOn":?,
"workflowId":?,
"loggedInUserId":?,
"isMultiple":?,
"tags":"?",
"tagNames":"?",
"hardwareAsset":"?",
"customerId":"?",
"userId":"?",
"extraValue":"?",
"editValue":[
{
"id":2147483647,
"property":"?",
"value":"?",
"blockId":"?"
} ]
}
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":1319733301,
"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":2039388990,
"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":"?",
},
"hostedOn": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"properties":[
{
"id":277230010,
"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":"?"
} ]
}
getCIPartProp POST Interface
Description:
Service to get all component CIs of this CI.
Method: POST Relative URL: android-service/get-cipart-prop/record-id/group-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETCIPARTPROP
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getSoftwareVendorListsForDiscoverItem POST Interface
Method: POST Relative URL: android-service/get-software-vendor-lists/ci-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETSOFTWAREVENDORLISTSFORDISCOVERITEM
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":439345422,
"response":"?"
}
deleteRecord POST Interface
Method: POST Relative URL: android-service/delete-record/id/module Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: DELETERECORD
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":713541756,
"response":"?"
}
searchRecord POST Interface
Method: POST Relative URL: android-service/search-record/db-class/db-property/limit Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | PopupSearchAndoid | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: SEARCHRECORD
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"value":"?",
"isKnownError":?,
"isTemplate":?,
"isCmdbCi":?,
"isRootCauseCi":?,
"customerId":"?",
"userId":"?",
"extraValue":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllStoresByLocation POST Interface
Method: POST Relative URL: android-service/get-all-stores-by-location Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| id | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLSTORESBYLOCATION
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllCertificatesByStore POST Interface
Method: POST Relative URL: android-service/get-all-certificates-by-store Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| id | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLCERTIFICATESBYSTORE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllLocationByIp POST Interface
Method: POST Relative URL: android-service/get-all-location Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| id | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLLOCATIONBYIP
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getEBSForInstance POST Interface
Method: POST Relative URL: android-service/get-ebs-for-instance/source-id/type Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETEBSFORINSTANCE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllIpConnections POST Interface
Description:
Service to get all component CIs of this CI.
Method: POST Relative URL: android-service/get-ip-connections/record-id/group-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLIPCONNECTIONS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllIncidentsWithMinimalValues POST Interface
Method: POST Relative URL: android-service/get-all-incidents-with-minimal-values Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLINCIDENTSWITHMINIMALVALUES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getDefaultTemplate POST Interface
Description:
Service to get default incident model to create an incident.
Method: POST Relative URL: android-service/get-default-model Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETDEFAULTTEMPLATE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getIncident POST Interface
Description:
Service to get the particular incident details.
Method: POST Relative URL: android-service/get-incident/incident-id/template-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: GETINCIDENT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getCI POST Interface
Description:
Service to get particular CI details.
Method: POST Relative URL: android-service/get/ci-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| record | Record | |
Example Request: GETCI
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":21805628,
"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":1455676598,
"name":"?",
"icon":"?",
"component":?,
"driveFileId":"?",
"driveFileId16Px":"?",
"driveFileId256Px":"?",
"configureMainPage":"?"
},
"parentCI": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"vendor": {
"id":287635685,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"licenseKey": {
"id":299695433,
"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":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":2147483647,
"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":930276111,
"groupName":"?",
"groupOrder":?,
"archive":?,
"lastModifiedBy": {
"id":2109463725,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"lastModifiedOn":?,
"createdOn":?,
"defaultColumn":?,
"uniqueId":"?"
} ]
}
getDiscovredItem POST Interface
Description:
Service to get particular CI details.
Method: POST Relative URL: android-service/get-discovered-item/ci-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETDISCOVREDITEM
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getScanDetails POST Interface
Description:
Service to get particular CI details.
Method: POST Relative URL: android-service/get-scan-details/scan-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETSCANDETAILS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getUserDetails POST Interface
Method: POST Relative URL: android-service/get-user-details Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | UserDetails | |
Example Request: GETUSERDETAILS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"email":"?",
"password":"?",
"userName":"?",
"isAdmin":?,
"isEndUser":?,
"isCustomer":?,
"firstName":"?",
"lastName":"?",
"displayName":"?",
"phone":"?",
"uniqueId":"?",
"timeStamp":"?",
"fileName":"?",
"bucketName":"?",
"wikiLink":"?",
"logoPic":"?",
"theme":"?",
"Url":"?",
"landingPage":"?",
"currency":"?",
"language":"?",
"isVendor":?,
"sessionId":"?",
"isLocalStorage":"?",
"downloadLink":"?",
"storageType":"?",
"driveLink":"?",
"driveLinkForOrganization":"?",
"chatServerAddress":"?",
"isSuperAdmin":?,
"organizationName":"?",
"integrationEnabled":?,
"serviceNowDomain":"?",
"serverPort":"?",
"nettyPort":"?",
"severAddress":"?",
"isSuperEndUser":?,
"ivantiDomain":"?",
"jiraDomain":"?",
"isCherwellIntegrationEnabled":?,
"subscribedModules":"?",
"newUIEnabled":?,
"enableMFA":?,
"mfaChecked":?,
"twoFactorSecretKey":"?",
"mfaType":"?",
"timezone":"?"
}
getAllProperties POST Interface
Method: POST Relative URL: android-service/get-all-properties Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| properties | PropertyList | |
Example Request: GETALLPROPERTIES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":261117590,
"properties":[
{
"id":2147483647,
"groupName":"?",
"propertyName":"?",
"columnName":"?",
"dataType":"?",
"defaultColumn":"?",
"mandatory":"?"
} ]
}
getAllGroupsName POST Interface
Method: POST Relative URL: android-service/get-all-groups-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| groupList | GroupList | |
Example Request: GETALLGROUPSNAME
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"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":"?"
} ]
}
getAllMandatoryPropertiesForAddNewCi POST Interface
Method: POST Relative URL: android-service/get-all-mandatory-properties Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| propertyList | ValueList | |
Example Request: GETALLMANDATORYPROPERTIESFORADDNEWCI
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"StringList":[
{
"id":728063136,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"projectList":[
{
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
getBluePrints POST Interface
Method: POST Relative URL: android-service/get-blue-prints Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| bluePrints | ArrayOfBluePrints | |
Example Request: GETBLUEPRINTS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"bluePrints":[
{
"id":2147483647,
"name":"?",
"createdOn":?,
"lastModifiedOn":?,
"icon":"?",
"workflow":"?",
"component":?,
"archive":?,
"system":?,
"used":?,
"version":?,
"json":?,
"integrityCheck":?,
"includes":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"relatedPossibleComponent":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"propertyList":[
{
"id":309469691,
"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":1368828437,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"secretPropertyRoleList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"integrityCheckProperties":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"secondLevelSupportUser": {
"id":1745556875,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"thirdLevelSupportUser": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"secondLevelSupportGroup": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"thirdLevelSupportGroup": {
"id":231667468,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"driveFileId":"?",
"driveFileId16Px":"?",
"driveFileId256Px":"?",
"tagNames":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"configureMainPage":"?",
"missingComponents":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ]
} ]
}
getAllPropertiesWithDataType POST Interface
Description:
Service to get all properties of CMDB module for particular blueprint with their data types for front-end validations.
Method: POST Relative URL: android-service/get-properties-with-datatype/blueprint-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: GETALLPROPERTIESWITHDATATYPE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
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: android-service/get-ci-part-names Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETCIPARTNAMEFORBLUEPRINT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getStatusPossibleValues POST Interface
Description:
Service to get status and its approval type.
Method: POST Relative URL: android-service/get-status-possible-values Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: GETSTATUSPOSSIBLEVALUES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
addRecordCMDBFromUI POST Interface
Description:
Service to add CI record and store audit record for that CI.
Method: POST Relative URL: android-service/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 | MultiMapAndroid | |
Response Structure: | Field Name | Type | Description |
|---|
| transactionMeassage | TransactionMessage | |
Example Request: ADDRECORDCMDBFROMUI
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"checkExists":?,
"workFlowId":?,
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"map":[
{
"key":"?",
"value":"?",
"blockId":"?"
} ]
}
Example Response: {
"id":1590770933,
"recordId":"?",
"message":"?",
"status":?
}
saveSoftwareLink POST Interface
Method: POST Relative URL: android-service/save-software-link/version Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| link | DataInputAndroid | Link of software |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | The response |
Example Request: SAVESOFTWARELINK
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"name":"?",
"dataValue":"?",
"description":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
addComment POST Interface
Method: POST Relative URL: android-service/add-comment Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| comment | Comment | |
Response Structure: | Field Name | Type | Description |
|---|
| comments | ArrayOfComment | |
Example Request: ADDCOMMENT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"entityId":?,
"entityValue":"?",
"commentValue":"?",
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"addedBy":"?",
"attachmentsList":"?"
}
Example Response: {
"id":2147483647,
"comments":[
{
"id":2147483647,
"commentId":?,
"userName":"?",
"entityId":?,
"entityValue":"?",
"commentValue":"?",
"date":?,
"addedBy":"?",
"attachmentsList":"?"
} ]
}
getAllComments POST Interface
Method: POST Relative URL: android-service/get-all-comments/entity-id/entity-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| tasks | ArrayOfComment | |
Example Request: GETALLCOMMENTS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"comments":[
{
"id":2147483647,
"commentId":?,
"userName":"?",
"entityId":?,
"entityValue":"?",
"commentValue":"?",
"date":?,
"addedBy":"?",
"attachmentsList":"?"
} ]
}
archiveComment POST Interface
Method: POST Relative URL: android-service/archive-comment Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: ARCHIVECOMMENT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllTask POST Interface
Method: POST Relative URL: android-service/get-all-tasks/entity-i-d/entity Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| tasks | ArrayOfTask | |
Example Request: GETALLTASK
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"totalTime":?,
"tasks":[
{
"id":2147483647,
"entityId":?,
"entity":"?",
"taskType":"?",
"taskValue":"?",
"dueDate":?,
"assignee":"?",
"groupAssignee":"?",
"status":"?",
"lastModifiedBy":"?",
"createdBy":"?",
"createdOn":?,
"lastModifiedOn":?,
"completed":?,
"totalTimeSpent":?,
"sentItemId":?,
"url":"?",
"reAssignRestricted":?,
"notes":"?"
} ]
}
getUploadedFiles POST Interface
Method: POST Relative URL: android-service/get-all-attachments/entity-id/entity-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| responseMsg | ArrayAttachList | Array of files with fileId |
Example Request: GETUPLOADEDFILES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"customerId":"?",
"userId":"?",
"listFiles":[
{
"id":2147483647,
"attachmentId":?,
"name":"?",
"fileName":"?",
"entity":"?",
"status":"?",
"version":"?",
"uploadedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uploadedOn":?,
"driveFileId":"?",
"fileSize":?,
"description":"?",
"isRunBookAttachment":?
} ]
}
getAllHistory POST Interface
Method: POST Relative URL: android-service/get-all-history/entity-i-d/entity Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLHISTORY
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllAudits POST Interface
Method: POST Relative URL: android-service/get-all-audits/entity-i-d/entity Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLAUDITS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllMaintenance POST Interface
Method: POST Relative URL: android-service/get-all-maintenance/entity-i-d/entity Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLMAINTENANCE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
addMaintenance POST Interface
Description:
Service to update a CI record and store audit record for that CI.
Method: POST Relative URL: android-service/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 POST Interface
Description:
Service to get all the relations of the particular CI with other CIs.
Method: POST Relative URL: android-service/get-relation/record-id/level/view Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| recordRelations | RecordRelationArray | |
Example Request: GETRECORDRELATION
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"recordRelation":[
{
"id":319320617,
"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":492681526,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"sourceLocation": {
"id":1286798346,
"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":"?"
}
getAllReporters POST Interface
Method: POST Relative URL: android-service/get-all-reporters Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLREPORTERS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":550577830,
"response":"?"
}
getAllUsersForThisRole POST Interface
Method: POST Relative URL: android-service/get-all-users Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLUSERSFORTHISROLE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllLicenseKey POST Interface
Description:
Service to get all the license keys of this Software CI.
Method: POST Relative URL: android-service/get-all-license-key Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: GETALLLICENSEKEY
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":800242370,
"response":"?"
}
associateFloatingComponents POST Interface
Method: POST Relative URL: android-service/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":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":939558468,
"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":2147483647,
"response":"?"
}
getAllPropertiesForCiPart POST Interface
Method: POST Relative URL: android-service/get-prop-for-cipart/component-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| propertyList | AddComp | |
Example Request: GETALLPROPERTIESFORCIPART
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"CompStringList":[
{
"id":2147483647,
"stringObj":"?",
"shortName":"?",
"mandatory":"?"
} ]
}
getAllFloatingComponents POST Interface
Method: POST Relative URL: android-service/get-all-floating-components/blueprint-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| srchInput | PopupSearchAndoid | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLFLOATINGCOMPONENTS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":217366141,
"value":"?",
"isKnownError":?,
"isTemplate":?,
"isCmdbCi":?,
"isRootCauseCi":?,
"customerId":"?",
"userId":"?",
"extraValue":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
addCustomTimescale POST Interface
Method: POST Relative URL: android-service/add-custom-timescale/entity-id/module Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| editIncidentTimescaleList | EditTimescaleAndroid | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: ADDCUSTOMTIMESCALE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"responseTime":"?",
"resolutionTime":"?",
"firstLevelSupport":"?",
"secondLevelSupport":"?",
"thirdLevelSupport":"?",
"customerId":"?",
"userId":"?",
"extraValue":"?",
"timescaleNotifications":[
{
"customTimeScale":?,
"customTimescaleId": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"action":"?",
"timing":"?",
"minutes":"?",
"module":"?",
"notifyRoles":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"notifyUsers":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"notifyGroups":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"notifyDepartments":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"notifyProperties":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ]
} ]
}
Example Response: {
"id":2147483647,
"response":"?"
}
searchNotify POST Interface
Method: POST Relative URL: android-service/search-notify Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| editIncidentTimescaleList | NotificationSearchPojoAndroid | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: SEARCHNOTIFY
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"module":"?",
"searchFor":"?",
"value":"?",
"customerId":"?",
"userId":"?",
"extraValue":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getCustomTimescale POST Interface
Method: POST Relative URL: android-service/get-custom-timescale/entity-id/module Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | EditTimescale | |
Example Request: GETCUSTOMTIMESCALE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"responseTime":"?",
"resolutionTime":"?",
"firstLevelSupport":"?",
"secondLevelSupport":"?",
"thirdLevelSupport":"?",
"timescaleNotifications":[
{
"id":2147483647,
"customTimeScale":?,
"customTimescaleId": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"action":"?",
"timing":"?",
"minutes":"?",
"module":"?",
"notifyRoles":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"notifyUsers":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"notifyGroups":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"notifyDepartments":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"notifyProperties":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ]
} ]
}
addSourceTargetRelation POST Interface
Description:
Service to add relation between CIs.
Method: POST Relative URL: android-service/add-source-target-relation Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| recordRelationArray | RecordRelationArrayAndroid | |
Response Structure: | Field Name | Type | Description |
|---|
| message | TransactionMessage | |
Example Request: ADDSOURCETARGETRELATION
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"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":1081512172,
"groupId":?,
"source":?,
"target":?,
"level":?,
"sourceName":"?",
"targetName":"?",
"sourceBluePrint":"?",
"targetBluePrint":"?",
"sourcePort":"?",
"targetPort":"?",
"sourceIcon":"?",
"targetIcon":"?",
"sourceUnDiscovered":?,
"targetUnDiscovered":?,
"sourceAssignee": {
"id":142744526,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"targetAssignee": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"sourceOwner": {
"id":624906734,
"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,
"recordId":"?",
"message":"?",
"status":?
}
getAllCI POST Interface
Method: POST Relative URL: android-service/get-search-ci/page-number/limit Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| stringinput | StringInputAndroid | |
Response Structure: | Field Name | Type | Description |
|---|
| searchList | SearchResult | |
Example Request: GETALLCI
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"bluePrintId":?,
"searchkey":"?",
"ignoreIds":"?",
"rootCauseCI":?,
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraInfo":"?"
}
Example Response: {
"id":2147483647,
"SearchList":[
{
"id":2147483647,
"cmdbcid":?,
"arraysearch":[
{
"id":2147483647,
"blueprintname":"?",
"assetval":"?",
"assetId":"?",
"version":"?",
"recordId":"?",
"ciIcon":"?",
"blueprintIcon":"?",
"assetName":"?",
"status":"?",
"hostName":"?",
"os":"?",
"ip":"?"
} ]
} ],
"totalRecords":?
}
getScanLogs POST Interface
Method: POST Relative URL: android-service/get-scan-logs/id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| detail | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETSCANLOGS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
saveTagDetails POST Interface
Method: POST Relative URL: android-service/save-tag-details Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| detail | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: SAVETAGDETAILS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllclientName POST Interface
getAllName Service (GET) is called when a partner, or the application is trying to get all sensor names.
Method: POST Relative URL: android-service/get-all-client-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| filterSort | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| probeList | ValueList | |
Example Request: GETALLCLIENTNAME
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"StringList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"projectList":[
{
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":353757485,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":1703669377,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":231429806,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
refreshCMDBComponent POST Interface
Method: POST Relative URL: android-service/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":2147483647,
"response":"?"
}
getListenersForLoadBalancer POST Interface
Method: POST Relative URL: android-service/get-listeners-for-load-balancer/source-id/type Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| filterSort | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETLISTENERSFORLOADBALANCER
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAWSIpPermissions POST Interface
Method: POST Relative URL: android-service/get-ip-permissions Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| filterSort | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETAWSIPPERMISSIONS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getInstalledParentCIs POST Interface
Description:
Service to get all the installed parent CI's.
Method: POST Relative URL: android-service/get-installed-parent-cis/ciid Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| filterSort | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: GETINSTALLEDPARENTCIS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getFoldersForVcenter POST Interface
Service to get all associated folders for a particular vcenter blueprint
Method: POST Relative URL: android-service/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 | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETFOLDERSFORVCENTER
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getDatacentersForVcenter POST Interface
Service to get all associated datacenters for a particular vcenter blueprint
Method: POST Relative URL: android-service/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 | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETDATACENTERSFORVCENTER
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getClustersForVcenter POST Interface
Service to get all associated clusters for a particular vcenter blueprint
Method: POST Relative URL: android-service/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 | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETCLUSTERSFORVCENTER
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getHostsForVcenter POST Interface
Service to get all associated hosts for a particular vcenter blueprint
Method: POST Relative URL: android-service/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 | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETHOSTSFORVCENTER
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getTagsForVcenter POST Interface
Service to get all associated tags for a particular vcenter blueprint
Method: POST Relative URL: android-service/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 | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETTAGSFORVCENTER
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllGroupsForThisRole POST Interface
Method: POST Relative URL: android-service/get-all-groups Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLGROUPSFORTHISROLE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getCiFromBlueprint POST Interface
Method: POST Relative URL: android-service/get-ci-from-blueprint/limit Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | PopupSearchAndoid | |
Response Structure: | Field Name | Type | Description |
|---|
| response | SearchResult | |
Example Request: GETCIFROMBLUEPRINT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"value":"?",
"isKnownError":?,
"isTemplate":?,
"isCmdbCi":?,
"isRootCauseCi":?,
"customerId":"?",
"userId":"?",
"extraValue":"?"
}
Example Response: {
"id":2147483647,
"SearchList":[
{
"id":2147483647,
"cmdbcid":?,
"arraysearch":[
{
"id":2147483647,
"blueprintname":"?",
"assetval":"?",
"assetId":"?",
"version":"?",
"recordId":"?",
"ciIcon":"?",
"blueprintIcon":"?",
"assetName":"?",
"status":"?",
"hostName":"?",
"os":"?",
"ip":"?"
} ]
} ],
"totalRecords":?
}
addIncident POST Interface
Description:
Service to create incidents. This service is a POST service which takes parameter of type EditValuesArray.
It creates an incident and stores audit record for that incident. It also schedules the incident based
on the timescale defined by the client and the current state to check for any Service Level Agreement(SLA) violations.
Method: POST Relative URL: android-service/add-incident Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| editValuesArray | EditValuesArray | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: ADDINCIDENT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"entityId":?,
"customerId":"?",
"mspClientId":"?",
"module":"?",
"workflowId":?,
"templateName":"?",
"templateId":"?",
"selectedTemplate":"?",
"accessRoles":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"isTemplate":?,
"isMultiple":?,
"archive":?,
"currentAssigneeRole":"?",
"isIncident":?,
"moving":?,
"createdFromTask":?,
"checkSession":?,
"loggedInUserId":?,
"createdFromEntity":"?",
"createdFromEntityId":?,
"privatePropertyList":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"privatePropertyRoleList":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"timescale":[
{
"responseTime":"?",
"resolutionTime":"?",
"firstLevelSupport":"?",
"secondLevelSupport":"?",
"thirdLevelSupport":"?",
"timescaleNotifications":[
{
"customTimeScale":?,
"action":"?",
"timing":"?",
"minutes":"?",
"module":"?",
} ]
} ],
"editValues":[
{
"property":"?",
"value":"?",
"blockId":"?"
} ],
"totalTimeSpent":?,
"userEmailId":"?",
"fromSACM":?,
"copyId":"?",
"isCopiedByPrimaryCustomer":?,
"mspIncidentId":"?",
"idList":[
{
"flag":?
} ],
"isImport":?,
"isBulkUpdate":?
}
Example Response: {
"id":2147483647,
"response":"?"
}
editIncident POST Interface
Description:
Service to edit incidents. This service is a POST service which takes parameter of type EditValuesArray.
It updates an incident and stores audit record for that incident. It re-schedules the incident based
on the timescale defined by the client, if any state change is done, to check for any Service Level Agreement(SLA) violations.
Method: POST Relative URL: android-service/edit-incident Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| editValuesArray | EditValuesArray | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: EDITINCIDENT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"entityId":?,
"customerId":"?",
"mspClientId":"?",
"module":"?",
"workflowId":?,
"templateName":"?",
"templateId":"?",
"selectedTemplate":"?",
"accessRoles":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"isTemplate":?,
"isMultiple":?,
"archive":?,
"currentAssigneeRole":"?",
"isIncident":?,
"moving":?,
"createdFromTask":?,
"checkSession":?,
"loggedInUserId":?,
"createdFromEntity":"?",
"createdFromEntityId":?,
"privatePropertyList":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"privatePropertyRoleList":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"timescale":[
{
"responseTime":"?",
"resolutionTime":"?",
"firstLevelSupport":"?",
"secondLevelSupport":"?",
"thirdLevelSupport":"?",
"timescaleNotifications":[
{
"customTimeScale":?,
"action":"?",
"timing":"?",
"minutes":"?",
"module":"?",
} ]
} ],
"editValues":[
{
"property":"?",
"value":"?",
"blockId":"?"
} ],
"totalTimeSpent":?,
"userEmailId":"?",
"fromSACM":?,
"copyId":"?",
"isCopiedByPrimaryCustomer":?,
"mspIncidentId":"?",
"idList":[
{
"flag":?
} ],
"isImport":?,
"isBulkUpdate":?
}
Example Response: {
"id":2147483647,
"response":"?"
}
deleteRecords POST Interface
Method: POST Relative URL: android-service/delete-records/db-class/module 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: DELETERECORDS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"scanId":?,
"workflowId":?,
"fromSACM":?,
"customerId":"?",
"userId":"?",
"startTime":"?",
"idList":[
{
"id":1329785534,
"flag":?
} ]
}
Example Response: {
"id":2147483647,
"response":"?"
}
reScanWithScanId POST Interface
reScanWithScanId(POST) is called when user is trying to rescan an existing scan.
- id of the scan which user is trying to rescan need to be passed. Service fetches the existing scan details from table and calls the editDiscoveryScan method with those details.
Method: POST Relative URL: android-service/rescan Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| discoveryScan | Response | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: RESCANWITHSCANID
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"response":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
editParentAudit POST Interface
Method: POST Relative URL: android-service/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":"?"
}
addTask POST Interface
Method: POST Relative URL: android-service/add-task Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| task | AddTask | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: ADDTASK
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"entityId":?,
"entity":"?",
"customerId":"?",
"userId":"?",
"taskType":"?",
"taskValue":"?",
"dueDate":?,
"assignee":?,
"groupAssignee":?,
"status":"?",
"totalTimeSpent":?,
"sentItemId":?,
"notes":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
editTask POST Interface
Method: POST Relative URL: android-service/edit-task Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| updateTask | UpdateTask | |
Response Structure: | Field Name | Type | Description |
|---|
| task | Task | |
Example Request: EDITTASK
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"entityId":?,
"entity":"?",
"taskType":"?",
"customerId":"?",
"userId":"?",
"taskValue":"?",
"dueDate":?,
"assignee":?,
"groupAssignee":?,
"status":"?",
"completed":?,
"archive":?,
"sentItemId":?,
"allowTemporaryAccess":?,
"notes":"?"
}
Example Response: {
"id":2147483647,
"entityId":?,
"entity":"?",
"taskType":"?",
"taskValue":"?",
"dueDate":?,
"assignee":"?",
"groupAssignee":"?",
"status":"?",
"lastModifiedBy":"?",
"createdBy":"?",
"createdOn":?,
"lastModifiedOn":?,
"completed":?,
"totalTimeSpent":?,
"sentItemId":?,
"url":"?",
"reAssignRestricted":?,
"notes":"?"
}
archiveTask POST Interface
Method: POST Relative URL: android-service/archive-task Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| taskId | ArrayOfTaskId | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: ARCHIVETASK
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"tasks":[
{
"taskId":?
} ]
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllIncidentTemplates POST Interface
Method: POST Relative URL: android-service/get-all-incident-templates Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: GETALLINCIDENTTEMPLATES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
uploadDocument FILE Interface
Method: FILE Relative URL: android-service/upload-attachments Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| responseMsg | TransactionMessage | The response |
Example Request: Example Response: {
"id":326628376,
"recordId":"?",
"message":"?",
"status":?
}
uploadSoftwareFile FILE Interface
Method: FILE Relative URL: android-service/upload-software-file/version 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":2147483647,
"response":"?"
}
detachAttatchment POST Interface
Method: POST Relative URL: android-service/detach-attatchments Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| attachFileList | ArrayAttachList | |
Response Structure: | Field Name | Type | Description |
|---|
| responseMsg | Response | Response |
Example Request: DETACHATTATCHMENT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"listFiles":[
{
"attachmentId":?,
"name":"?",
"fileName":"?",
"entity":"?",
"status":"?",
"version":"?",
"uploadedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uploadedOn":?,
"driveFileId":"?",
"fileSize":?,
"description":"?",
"isRunBookAttachment":?
} ]
}
Example Response: {
"id":2147483647,
"response":"?"
}
deleteRelations POST Interface
Method: POST Relative URL: android-service/delete-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: DELETERELATIONS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":1853558344,
"scanId":?,
"workflowId":?,
"fromSACM":?,
"customerId":"?",
"userId":"?",
"startTime":"?",
"idList":[
{
"id":2147483647,
"flag":?
} ]
}
Example Response: {
"id":2147483647,
"response":"?"
}
getTaskStatus POST Interface
Description:
Service to get the procedure to handle incident.
Method: POST Relative URL: android-service/get-task-status Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: GETTASKSTATUS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":1389772568,
"response":"?"
}
getTimezonesWithDefault POST Interface
Method: POST Relative URL: android-service/get-timezones-with-default Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| record | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: GETTIMEZONESWITHDEFAULT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":1415207719,
"response":"?"
}
deleteAllCiPartRecords POST Interface
Description:
Service to archive the selected component CIs.
Method: POST Relative URL: android-service/delete-cipart-records Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| input | BasicDetail | |
Response Structure: | Field Name | Type | Description |
|---|
| transactionMeassage | Response | |
Example Request: DELETEALLCIPARTRECORDS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"customerId":"?",
"userId":"?",
"extraValue":"?",
"extraParameter":"?",
"searchValue":"?",
"pageNo":"?",
"module":"?",
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllProbeNameAndType GET Interface
getAllName Service (GET) is called when a partner, or the application is trying to get all sensor names.
Method: GET Relative URL: android-service/get-all-probe-name-and-type Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| probeList | ProbeValueList | |
Example Request: Example Response: {
"id":2147483647,
"StringList":[
{
"id":231941393,
"stringobj":"?",
"probeType":"?",
"audit":?
} ]
}
getAllclientName GET Interface
getAllName Service (GET) is called when a partner, or the application is trying to get all sensor names.
Method: GET Relative URL: android-service/get-all-client-name Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| probeList | ValueList | |
Example Request: Example Response: {
"id":2147483647,
"StringList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"projectList":[
{
"id":1964757195,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":1245088188,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":1445836021,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
editDiscoveryScan POST Interface
editDiscoveryScan(POST) is called when user is trying to add/edit a discovery scan.
- If the id is -1 then, it create a new discovery scan
- else if id is there, then the record get edited else it throws an error.
Method: POST Relative URL: android-service/discoveryscanedit Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| discoveryScan | DiscoveryScan | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: EDITDISCOVERYSCAN
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"name":"?",
"scanId":"?",
"totalTime":?,
"status":"?",
"scanLogs":"?",
"parameters":"?",
"archive":?,
"isCompleted":?,
"isAborted":?,
"probeId":?,
"probeType":"?",
"groupProbeId":?,
"clientId":?,
"credentialId":?,
"probeName":"?",
"clientName":"?",
"clientSessionId":"?",
"uniqueId":"?",
"roles":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"users":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"groups":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"departments":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"ipTocredentialIdMap":"?",
"runBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"location": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"startTime":?,
"endTime":?,
"triggeredFromScheduledScan":?,
"excludeIP":"?",
"ports":"?",
"daIpAddress":"?",
"certificatePath":"?",
"registryPath":"?",
"softwareUrl":"?",
"installArguments":"?",
"auditId":?,
"isFromIPAM":?,
"blueprintMSSQL":"?",
"isCreateDiscAsset":?,
"isExportData":?,
"isDiscAssetAvailable":?,
"isExportDataDone":?,
"mssqlDataMappingParameters":"?",
"mssqlQuery":"?",
"isQuickScan":?,
"isHostNamesScan":?,
"hostNames":"?"
}
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: android-service/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":"?"
}
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: android-service/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":"?"
}
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: android-service/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":"?"
}
moveAllDiscoveredItems POST Interface
Description:
Service to move all the selected records in discovery to CMDB.
Method: POST Relative URL: android-service/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":1439151575,
"response":"?"
}
addAWSImport POST Interface
Description : This service will add AWS Import and get the EC2 data
Method: POST Relative URL: android-service/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":"?"
}
addAZUREImport POST Interface
Description : This service will take user's azure portal details and import data from azure subscription
Method: POST Relative URL: android-service/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":30623203,
"response":"?"
}
getAllCredentialsByType GET Interface
getAllCredentials Service (GET) is called when a partner, or the application is trying to get all credentials.
Method: GET Relative URL: android-service/get-all-credentials-by-type/type Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| credentialList | ValueList | |
Example Request: Example Response: {
"id":2147483647,
"StringList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"projectList":[
{
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":90796074,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
|
