Virima API Specification - CommonService Services

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

Contents

1 getUsers GET Interface
2 getAllRelationshipTypes GET Interface
3 getBluePrints GET Interface
4 getAllPropertyGroup GET Interface
5 saveFilter POST Interface
6 deleteFilter POST Interface
7 getAllFilter GET Interface
8 getFilterOperators GET Interface
9 setDefaultFilter POST Interface
10 removeDefaultFilter POST Interface
11 getAllITAMProperties GET Interface
12 getAllITSMProperties GET Interface
13 getAllSensorName GET Interface
14 getAllProbeName GET Interface
15 getAllProbeNameAndType GET Interface
16 getAllclientName GET Interface
17 getAllCredentials GET Interface
18 getAllCredentialsByType GET Interface
19 getAwsCredentials GET Interface
20 getAllPrimaryRelationShips GET Interface
21 getAllUserTypeRelationShips GET Interface
22 getCI POST Interface
23 getSoftwareLicenseKeys POST Interface
24 getCmdbAssetNames GET Interface
25 getAllPropertiesName GET Interface
26 deleteRecords POST Interface
27 deleteAssociation POST Interface
28 delete POST Interface
29 getAllPropertiesForCiPart GET Interface
30 getAllMandatoryPropertiesForAddNewCi GET Interface
31 getDefaultPropForCiPart GET Interface
32 getAccessControls GET Interface
33 getAllUsersForThisRole POST Interface
34 getAllUsersForThisRoleWithMaxLimit POST Interface
35 getAllWorkflows POST Interface
36 getAllGroupsForThisRole POST Interface
37 getAllDependsOnProperties GET Interface
38 getAllReporters POST Interface
39 getAllIncidentTemplates GET Interface
40 getStateControl GET Interface
41 getDiscoveryAgentURL GET Interface
42 getCount GET Interface
43 getITILMetrics GET Interface
44 archiveDefaultReport POST Interface
45 orderReportsInDashBoard POST Interface
46 escalate POST Interface
47 updateTemplateProperties POST Interface
48 getItemDetails POST Interface
49 getRunningThreads GET Interface
50 getAllATasksFromAllModules GET Interface
51 editErrorCode POST Interface
52 getInfrastructureSummary GET Interface
53 locateCIsInMap GET Interface
54 locateIncidentsInMap GET Interface
55 locateChangesInMap GET Interface
56 getMapKey GET Interface
57 getAllLocationsInSpecifiedLocation GET Interface
58 getRecordIds GET Interface
59 exportTasks POST Interface
60 addMultipleProperties POST Interface
61 getOrgTimeZone GET Interface
62 getTimezones GET Interface
63 getTimezonesWithDefault GET Interface
64 getAllCustomerList POST Interface
65 isPrimaryCustomer GET Interface
66 moveRecordsToCustomers POST Interface
67 copyRecordsToCustomers POST Interface
68 addTags POST Interface
69 getAllPropertiesForAdvancedSearch GET Interface
70 getAllITSMPropertiesAdvancedSearch GET Interface
71 getAllITAMPropertiesAdvancedSearch GET Interface
72 getAllPropertiesForBlueprint GET Interface
73 getAllPropertiesForBlueprints POST Interface
74 getAllSoftwareLicenseGroups GET Interface
75 getAllSoftwareVendors GET Interface
76 getAllProbeNameAndTypeForRunBook GET Interface
77 getEscalationConfiguration GET Interface
78 saveEscalationConfiguration POST Interface
79 deleteCatalogAssociation POST Interface
80 getAllProbeNameAndTypeForMaintainence GET Interface
81 getDisabledApproverRoles GET Interface
82 addRecord POST Interface
83 getAllIntegrationDetails GET Interface
84 orderReportsDashboardNewUi POST Interface
85 fetchOrderReportsDashboardNewUi GET Interface
86 deleteFilterForNewUI GET Interface
87 getLogs GET Interface
88 getPropertyDetailGroups GET Interface
89 getPropertyDetailHardwareGroups GET Interface
90 getGroupDetailByOrder GET Interface
91 getHardGroupDetailByOrder GET Interface
92 getAllHARDProperties GET Interface
93 getPropertyDetailVendorGroups GET Interface
94 getVendorGroupDetailByOrder GET Interface
95 getAllVENDORProperties GET Interface
96 deleteSubCatalogItemsFromVendor POST Interface
97 bulkUpdateForITAMModules POST Interface
98 getCustomizedPropertiesForModule GET Interface
99 checkItamImportStatus GET Interface
100 abortImport GET Interface

getUsers GET Interface

Method: GET

Relative URL: common-service/get-users

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
users	ArrayOfUsers

Example Request:

Example Response:

{
   "id":2147483647,
   "userDetails":[
      {
         "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":"?"
      }   ]
}

getAllRelationshipTypes GET Interface

getAllName Service (GET) is called when a partner, or the application is trying to get all sensor names.

Kills an active session

Method: GET

Relative URL: common-service/get-all-relationship-type

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":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":1299213090,
               "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 GET Interface

Method: GET

Relative URL: common-service/get-blue-prints

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
bluePrints	ArrayOfBluePrints

Example Request:

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":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "primaryPropertyList":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "secretPropertyList":[
            {
               "id":279076411,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "mainPropertyList":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "mandatoryPropertyList":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "secretPropertyRoleList":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "integrityCheckProperties":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":549074975,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "secondLevelSupportUser": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "thirdLevelSupportUser": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "secondLevelSupportGroup": {
               "id":787324071,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "thirdLevelSupportGroup": {
               "id":1816177296,
               "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":"?",
            }         ]
      }   ]
}

getAllPropertyGroup GET Interface

Method: GET

Relative URL: common-service/get-all-property-group

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
propertyGroup	Response

Example Request:

Example Response:

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

saveFilter POST Interface

save filter(POST) is called when the application needs to get all the risk Records.

Method: POST

Relative URL: common-service/save-filter/entity/filter-name/scan-id/is-default

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterInput	SaveFilterInput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVEFILTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "className":"?",
   "dbClassName":"?",
   "subnetVal":"?",
   "filters":[
      {
         "id":2147483647,
         "display":"?",
         "filterKey":"?",
         "value1":"?",
         "value2":"?",
         "operator":"?",
         "dbPropertyType":"?",
         "mapProperty":?
      }   ]
}

Example Response:

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

deleteFilter POST Interface

save filter(POST) is called when the application needs to get all the risk Records.

Method: POST

Relative URL: common-service/delete-filter

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
deleteInput	DeleteRequest

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEFILTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "recordId":?,
   "scanId":?,
   "entity":"?",
   "isParser":"?"
}

Example Response:

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

getAllFilter GET Interface

save filter(POST) is called when the application needs to get all the risk Records.

Method: GET

Relative URL: common-service/get-all-filter/entity/scan-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
filters	FilterOutput

Example Request:

Example Response:

{
   "id":2147483647,
   "filters":[
      {
         "id":2147483647,
         "filterName":"?",
         "scanId":"?",
         "isDefault":?,
         "ListOfRule":[
            {
               "id":2147483647,
               "display":"?",
               "filterKey":"?",
               "value1":"?",
               "value2":"?",
               "operator":"?",
               "dbPropertyType":"?",
               "mapProperty":?
            }         ]
      }   ]
}

getFilterOperators GET Interface

save filter(POST) is called when the application needs to get all the risk Records.

Method: GET

Relative URL: common-service/get-filter-operators

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
filterOperatorList	FilterOperatorList

Example Request:

Example Response:

{
   "id":2147483647,
   "filterOpertor":[
      {
         "id":276083845,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

setDefaultFilter POST Interface

setDefaultFilter(POST) is called when the application needs to change the default filter.

Method: POST

Relative URL: common-service/set-default-filter

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterid	DeleteRequest

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SETDEFAULTFILTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "recordId":?,
   "scanId":?,
   "entity":"?",
   "isParser":"?"
}

Example Response:

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

removeDefaultFilter POST Interface

setDefaultFilter(POST) is called when the application needs to change the default filter.

Method: POST

Relative URL: common-service/remv-default-filter

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterid	DeleteRequest

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

REMOVEDEFAULTFILTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "recordId":?,
   "scanId":?,
   "entity":"?",
   "isParser":"?"
}

Example Response:

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

getAllITAMProperties GET Interface

Method: GET

Relative URL: common-service/get-all-itam-properties/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllITSMProperties GET Interface

Method: GET

Relative URL: common-service/get-all-itsm-properties/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllSensorName GET Interface

getAllName Service (GET) is called when a partner, or the application is trying to get all sensor names.

Kills an active session

Method: GET

Relative URL: common-service/get-all-sensor-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
sensorList	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":571770378,
               "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":?
      }   ]
}

getAllProbeName GET Interface

getAllName Service (GET) is called when a partner, or the application is trying to get all sensor names.

Kills an active session

Method: GET

Relative URL: common-service/get-all-probe-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":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":1763334125,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":823457843,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getAllProbeNameAndType GET Interface

getAllName Service (GET) is called when a partner, or the application is trying to get all sensor names.

Kills an active session

Method: GET

Relative URL: common-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":1778504132,
         "stringobj":"?",
         "probeType":"?",
         "audit":?
      }   ]
}

getAllclientName GET Interface

getAllName Service (GET) is called when a partner, or the application is trying to get all sensor names.

Kills an active session

Method: GET

Relative URL: common-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":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":844695424,
               "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":?
      }   ]
}

getAllCredentials GET Interface

getAllCredentials Service (GET) is called when a partner, or the application is trying to get all credentials.

Method: GET

Relative URL: common-service/get-all-credentials

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":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getAllCredentialsByType GET Interface

getAllCredentials Service (GET) is called when a partner, or the application is trying to get all credentials.

Method: GET

Relative URL: common-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":938459119,
         "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":2134409819,
               "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":?
      }   ]
}

getAwsCredentials GET Interface

Method: GET

Relative URL: common-service/get-aws-credentials/subscription-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllPrimaryRelationShips GET Interface

Method: GET

Relative URL: common-service/get-all-primary-relations

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
primaryrelationlist	ValueList

Example Request:

Example Response:

{
   "id":343707120,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":138287409,
               "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":?
      }   ]
}

getAllUserTypeRelationShips GET Interface

Method: GET

Relative URL: common-service/get-all-usertype-relations

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
primaryrelationlist	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":1888772737,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":1326620288,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getCI POST Interface

Method: POST

Relative URL: common-service/get-search-ci/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
stringinput	StringInput

Response Structure:

Field Name	Type	Description
searchList	SearchResult

Example Request:

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

Example Response:

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

getSoftwareLicenseKeys POST Interface

Method: POST

Relative URL: common-service/get-search-software-license-key/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
stringinput	StringInput

Response Structure:

Field Name	Type	Description
searchList	SearchResult

Example Request:

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

Example Response:

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

getCmdbAssetNames GET Interface

Method: GET

Relative URL: common-service/get-cmdb-assetnames

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
assetNameList	ValueList

Example Request:

Example Response:

{
   "id":1151960031,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":1413917878,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":407685016,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":1280104239,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":713381134,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":869385367,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getAllPropertiesName GET Interface

Method: GET

Relative URL: common-service/get-all-property-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
propertyList	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":821064415,
               "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":?
      }   ]
}

deleteRecords POST Interface

Method: POST

Relative URL: common-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":1385968153,
         "flag":?
      }   ]
}

Example Response:

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

deleteAssociation POST Interface

Method: POST

Relative URL: common-service/delete-association/db-class

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:

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

Example Response:

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

delete POST Interface

Method: POST

Relative URL: common-service/delete/db-class

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:

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

Example Response:

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

getAllPropertiesForCiPart GET Interface

Method: GET

Relative URL: common-service/get-prop-for-cipart/component-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
propertyList	AddComp

Example Request:

Example Response:

{
   "id":2147483647,
   "CompStringList":[
      {
         "id":2147483647,
         "stringObj":"?",
         "shortName":"?",
         "mandatory":"?"
      }   ]
}

getAllMandatoryPropertiesForAddNewCi GET Interface

Method: GET

Relative URL: common-service/get-all-mandatory-properties/blueprint-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
propertyList	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":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getDefaultPropForCiPart GET Interface

Method: GET

Relative URL: common-service/get-default-prop--cipart/component-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
propertyList	CompValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":2092846067,
         "stringobj":"?",
         "shortName":"?",
         "mandatory":"?"
      }   ]
}

getAccessControls GET Interface

Method: GET

Relative URL: common-service/get-access-controls/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllUsersForThisRole POST Interface

Method: POST

Relative URL: common-service/get-all-users

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
roleSrchInput	RoleSearch

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getAllUsersForThisRoleWithMaxLimit POST Interface

Method: POST

Relative URL: common-service/get-all-users-limit/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
roleSrchInput	RoleSearch

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getAllWorkflows POST Interface

Method: POST

Relative URL: common-service/get-all-workflows

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
roleSrchInput	RoleSearch

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getAllGroupsForThisRole POST Interface

Method: POST

Relative URL: common-service/get-all-groups

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
roleSrchInput	RoleSearch

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getAllDependsOnProperties GET Interface

Method: GET

Relative URL: common-service/get-all-depends/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllReporters POST Interface

Method: POST

Relative URL: common-service/get-all-reporters

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
reporterInput	ReportClass

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETALLREPORTERS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "value":"?",
   "email":"?",
   "phone":"?"
}

Example Response:

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

getAllIncidentTemplates GET Interface

Method: GET

Relative URL: common-service/get-all-incident-templates

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getStateControl GET Interface

Method: GET

Relative URL: common-service/get-state-control/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getDiscoveryAgentURL GET Interface

Description: Service to get Discovery Agent URL

Method: GET

Relative URL: common-service/get-discovery-agent

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

getCount GET Interface

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

Method: GET

Relative URL: common-service/get-count

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getITILMetrics GET Interface

Method: GET

Relative URL: common-service/get-itil-metrics/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

archiveDefaultReport POST Interface

Archives the itil metric from the particular entity

Method: POST

Relative URL: common-service/archive-default-report

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
post	DataInput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ARCHIVEDEFAULTREPORT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "dataValue":"?",
   "description":"?"
}

Example Response:

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

orderReportsInDashBoard POST Interface

save filter(POST) is called when the application needs to get all the risk Records.

Method: POST

Relative URL: common-service/order-reports-dashboard/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
reportList	ArrayOfId

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ORDERREPORTSINDASHBOARD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":90154232,
   "ids":[
      {
         "id":2147483647,
         "scopeId":?,
         "width":"?",
         "flag":?,
         "calendar":"?"
      }   ]
}

Example Response:

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

escalate POST Interface

This service is used for escalating the problem/incident to a higher level

Method: POST

Relative URL: common-service/escalate

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
post	Escalate

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ESCALATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "escalateTo":"?",
   "entity":"?",
   "rootCauseCiId":?,
   "recordId":?,
   "modelId":?
}

Example Response:

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

updateTemplateProperties POST Interface

This service is used for escalating the problem/incident to a higher level

Method: POST

Relative URL: common-service/update-template-properties

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:

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

getItemDetails POST Interface

Method: POST

Relative URL: common-service/get-item-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
filterInput	FilterInput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getRunningThreads GET Interface

Method: GET

Relative URL: common-service/get-running-threads

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

getAllATasksFromAllModules GET Interface

Method: GET

Relative URL: common-service/get-all-tasks

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

editErrorCode POST Interface

Edit attribute detail

Method: POST

Relative URL: common-service/edit-error-code/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	AttributeDetail

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITERRORCODE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "action":"?",
   "category":"?",
   "stage":"?",
   "stagePosition":"?",
   "archive":?,
   "colour":"?",
   "role":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "user":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "group":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "department":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "slaAction":"?",
   "slaPhase":"?",
   "mandatoryDetails":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "subMandatoryDetails":[
      {
         "id":889885681,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "includeSubState":?,
   "image":"?",
   "approverRoles":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

getInfrastructureSummary GET Interface

Method: GET

Relative URL: common-service/get-infrastructure-summary

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

locateCIsInMap GET Interface

Method: GET

Relative URL: common-service/locate-cis-in-map

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

locateIncidentsInMap GET Interface

Method: GET

Relative URL: common-service/locate-incidents-in-map

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

locateChangesInMap GET Interface

Method: GET

Relative URL: common-service/locate-changes-in-map

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getMapKey GET Interface

Method: GET

Relative URL: common-service/get-map-key

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

getAllLocationsInSpecifiedLocation GET Interface

Method: GET

Relative URL: common-service/get-all-records-in-location-specified/location-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":"?"
}

getRecordIds GET Interface

Method: GET

Relative URL: common-service/get-record-ids/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

exportTasks POST Interface

Method: POST

Relative URL: common-service/export-tasks/entity/entity-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

addMultipleProperties POST Interface

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

Method: POST

Relative URL: common-service/add-multiple-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
propertyDetails	ImportData

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

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

Example Response:

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

getOrgTimeZone GET Interface

Method: GET

Relative URL: common-service/get-org-timezone

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getTimezones GET Interface

Method: GET

Relative URL: common-service/get-timezones

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
propertyList	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":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

getTimezonesWithDefault GET Interface

Method: GET

Relative URL: common-service/get-timezones-with-default

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getAllCustomerList POST Interface

Method: POST

Relative URL: common-service/get-all-customer-list

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
search	PopupSearch

Response Structure:

Field Name	Type	Description
propertyList	Response

Example Request:

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

Example Response:

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

isPrimaryCustomer GET Interface

Method: GET

Relative URL: common-service/is-primary-customer

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

moveRecordsToCustomers POST Interface

Method: POST

Relative URL: common-service/move-record-to-customers

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	MoveRecordToCustomers

Response Structure:

Field Name	Type	Description
propertyList	Response

Example Request:

MOVERECORDSTOCUSTOMERS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "module":"?",
   "customerIds":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "recordIds": {
         "id":2147483647,
         "actionType":"?",
      }
}

Example Response:

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

copyRecordsToCustomers POST Interface

Method: POST

Relative URL: common-service/copy-records-to-customers

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	MoveRecordToCustomers

Response Structure:

Field Name	Type	Description
propertyList	Response

Example Request:

COPYRECORDSTOCUSTOMERS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "module":"?",
   "customerIds":[
      {
         "id":1339681734,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "recordIds": {
         "id":2147483647,
         "actionType":"?",
      }
}

Example Response:

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

addTags POST Interface

Method: POST

Relative URL: common-service/add-tag

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportCIDetails

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

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

Example Response:

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

getAllPropertiesForAdvancedSearch GET Interface

Method: GET

Relative URL: common-service/get-all-properties-for-adv-search/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllITSMPropertiesAdvancedSearch GET Interface

Method: GET

Relative URL: common-service/get-all-itsm-properties-adv-search/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllITAMPropertiesAdvancedSearch GET Interface

Method: GET

Relative URL: common-service/get-all-itam-properties-adv-search/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getAllPropertiesForBlueprint GET Interface

Method: GET

Relative URL: common-service/get-all-properties-for-blueprint/blueprint-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":"?"
}

getAllPropertiesForBlueprints POST Interface

Method: POST

Relative URL: common-service/get-all-properties-for-blueprints

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:

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

Example Response:

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

getAllSoftwareLicenseGroups GET Interface

Method: GET

Relative URL: common-service/get-all-software-license-groups/ignore-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":"?"
}

getAllSoftwareVendors GET Interface

Method: GET

Relative URL: common-service/get-all-software-vendors

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

getAllProbeNameAndTypeForRunBook GET Interface

Method: GET

Relative URL: common-service/get-all-probe-name-and-type-for-runbook

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
valueList	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":1326928871,
               "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":?
      }   ]
}

getEscalationConfiguration GET Interface

Service to get saved escalation configuration

Method: GET

Relative URL: common-service/get-escalation-configuration/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
escalationConfiguration	EscalationConfiguration

Example Request:

Example Response:

{
   "id":2147483647,
   "enableEscalation":?,
   "enableRoundRobin":?,
   "module":"?"
}

saveEscalationConfiguration POST Interface

Service to save escalation configuration

Method: POST

Relative URL: common-service/save-escalation-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
escalationConfiguration	EscalationConfiguration

Response Structure:

Field Name	Type	Description
escalationConfiguration	EscalationConfiguration

Example Request:

SAVEESCALATIONCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "enableEscalation":?,
   "enableRoundRobin":?,
   "module":"?"
}

Example Response:

{
   "id":2147483647,
   "enableEscalation":?,
   "enableRoundRobin":?,
   "module":"?"
}

deleteCatalogAssociation POST Interface

Method: POST

Relative URL: common-service/delete-catalog-association

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:

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

Example Response:

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

getAllProbeNameAndTypeForMaintainence GET Interface

Method: GET

Relative URL: common-service/get-all-probe-name-and-type-for-maintainance

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
valueList	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":16987041,
               "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":?
      }   ]
}

getDisabledApproverRoles GET Interface

Method: GET

Relative URL: common-service/get-disabled-approver-roles/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

addRecord POST Interface

Method: POST

Relative URL: common-service/add-record

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportITILDetails

Response Structure:

Field Name	Type	Description
transactionMessage	TransactionMessage

Example Request:

ADDRECORD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "fileId":?,
   "fileName":"?",
   "module":"?",
   "templateName":"?",
   "isTemplate":?,
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "userFieldMapping":"?",
   "dateFieldMapping":"?",
   "associatedRecordMapping":"?"
}

Example Response:

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

getAllIntegrationDetails GET Interface

Method: GET

Relative URL: common-service/get-all-integration-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

orderReportsDashboardNewUi POST Interface

save filter(POST) is called when the application needs to get all the risk Records.

Method: POST

Relative URL: common-service/order-reports-dashboard-new-ui/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	StringPojoArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ORDERREPORTSDASHBOARDNEWUI 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "input":[
      {
         "id":2147483647,
         "width":"?",
         "height":"?",
         "xAxis":"?",
         "yAxis":"?",
         "layoutId":"?",
         "entity":"?",
         "moved":?,
         "staticData":?,
         "archive":?
      }   ]
}

Example Response:

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

fetchOrderReportsDashboardNewUi GET Interface

save filter(POST) is called when the application needs to get all the risk Records.

Method: GET

Relative URL: common-service/fetch-order-reports-dashboard-new-ui/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	StringPojoArray

Example Request:

Example Response:

{
   "id":2147483647,
   "input":[
      {
         "id":2147483647,
         "width":"?",
         "height":"?",
         "xAxis":"?",
         "yAxis":"?",
         "layoutId":"?",
         "entity":"?",
         "moved":?,
         "staticData":?,
         "archive":?
      }   ]
}

deleteFilterForNewUI GET Interface

save filter(POST) is called when the application needs to get all the risk Records.

Method: GET

Relative URL: common-service/delete-filter-for-new-ui/entity/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":"?"
}

getLogs GET Interface

Method: GET

Relative URL: common-service/get-logs/type/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":"?"
}

getPropertyDetailGroups GET Interface

Method: GET

Relative URL: common-service/get-groups

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getPropertyDetailHardwareGroups GET Interface

Method: GET

Relative URL: common-service/get-hard-groups

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getGroupDetailByOrder GET Interface

Method: GET

Relative URL: common-service/get-ui-groups

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

getHardGroupDetailByOrder GET Interface

Method: GET

Relative URL: common-service/get-ui-hard-groups

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

getAllHARDProperties GET Interface

Method: GET

Relative URL: common-service/get-all-hard-properties/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getPropertyDetailVendorGroups GET Interface

Method: GET

Relative URL: common-service/get-vendor-groups

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

getVendorGroupDetailByOrder GET Interface

Method: GET

Relative URL: common-service/get-ui-vendor-groups

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

getAllVENDORProperties GET Interface

Method: GET

Relative URL: common-service/get-all-vendor-properties/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

deleteSubCatalogItemsFromVendor POST Interface

Method: POST

Relative URL: common-service/delete-subcatalog-items

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:

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

Example Response:

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

bulkUpdateForITAMModules POST Interface

Method: POST

Relative URL: common-service/bulk-update-for-itam-modules/module

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:

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

getCustomizedPropertiesForModule GET Interface

Method: GET

Relative URL: common-service/get-customized-properties-for-module/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

checkItamImportStatus GET Interface

Method: GET

Relative URL: common-service/check-is-itam-import-processing/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

abortImport GET Interface

Method: GET

Relative URL: common-service/abort-import/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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