Virima API



Home
Commons
Constructs
Error Codes
Tester


SERVICES
CertificateManagementService
AgentResourceMonitor
AndroidService
AnnouncementService
AssetLicenseEntitlementService
ConsumableService
HardwareAssetService
OtherAssetService
SoftwareLicenseAssetService
StockRoomService
StockRoomTypeService
UserLicenseEntitlementService
AuditRecordService
BSMService
AvailabilityService
CommitmentScheduleService
OutagesService
OutScopeService
BusinessService
ServiceCommitment
ServiceOffering
InScopeService
ChangeAttributeService
ChangeApprovalServices
CherwellIntegrationService
CmdbAuditService
CMDBCIRelationship
CMDBCIVersion
CMDBCIService
CommentService
CommonService
ConfigurationServices
ContractService
CorrelationService
CostCenterService
CredentialService
CustomerService
CustomizedColumnsService
CyberArkService
DemandService
DesignationService
DevOpsService
DiscoveryService
DiscoveryMonitoringProfileService
DiscoveryClientService
DiscoveryPattern
DiscoveryScanService
DiscoveryScanSplitService
Document
DuplicatesAndRemediation
EMEmailService
EventService
ExternalAlertService
FederationService
FileService
FinanceService
GetRecordService
GroupProbeService
HelpDeskDashboardService
HomePageService
ImportCIService
ImportITILService
IncidentService
PriorityService
TimescaleService
IncidentAttributeService
InfoBloxService
AssetsAuditService
ITILMetricService
ITSMChangeService
ITSMTicketMgtService
IvantiIntegrationService
JiraIntegrationService
KnowledgeAttributeService
KnowledgeManagementService
LocationService
LoginService
MajorSoftwareService
MFAService
MMCCertificateService
OwnerService
PreprocessorService
PurchaseOrderService
PurchaseOrderLineItemService
ReceivingSlipService
ReceivingSlipsLineService
RequestItemService
RequestProcurementService
TransferOrderService
ProbeService
ProblemService
ProblemAttributeService
ProcessNetworkConnections
ProcessjobsService
ProgramService
ProjectService
PropertyGroupService
ReleaseManagementService
ReportDashBoardService
ReportingService
ReportingClauseService
ReportingOrderService
ReportPresentationService
RequestService
RequestAttributeService
AssessmentMasterAndQuestionService
RiskMangaementService
RoleAccessService
RuleService
RunBookService
SAMLService
SampleService
ScanService
SDPService
SearchService
SensorService
ServiceCatalog
ServiceNowMappingService
ServiceNowRecordService
SLAService
SoftwareMetricsService
ImportSpiceWorkTicketsService
SurveyMastersAndQuestions
TagService
TaskService
TaskTimeTrackingService
TimeTrackingExportService
TimeTrackingService
UCFADService
UnfuddleService
UserDepartmentService
UserGroupService
UserRoleService
UserService
VCenterHeirarchyService
VCenterTagsService
VendorService
WorkflowService
MenuService

Virima API Specification - GetRecordService Services

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

getAllRecords POST Interface

Method: POST

Relative URL: get-records/get-all/page-no/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
detailFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

resetPassword POST Interface

Method: POST

Relative URL: get-records/reset-password

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
resetPasswordResetADPassword

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

RESETPASSWORD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "email":"?",
   "instance":"?",
   "requestId":"?",
   "customerId":"?",
   "taskId":"?"
}

Example Response:

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

getAdvSearchList POST Interface

Method: POST

Relative URL: get-records/search-adv-list/db-class/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
advSearchInputAdvancedSearchInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

getPendingScans GET Interface

Method: GET

Relative URL: get-records/get-pending-scan/customer-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

Example Response:

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

getAllRecordsJira POST Interface

Method: POST

Relative URL: get-records/get-all-jira/page-no/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

getAllRecordsCherwell POST Interface

Method: POST

Relative URL: get-records/get-all-cherwell/page-no/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

getAllRecordsServiceNow POST Interface

Method: POST

Relative URL: get-records/get-all-sn/page-no/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

getAllRecordsIvanti POST Interface

Method: POST

Relative URL: get-records/get-all-ivanti/page-no/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

setCustomReportExport POST Interface

Method: POST

Relative URL: get-records/export-custom-report/reportid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
inputStringClass

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

getJSessionId GET Interface

Method: GET

Relative URL: get-records/get-jsessionid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

Example Response:

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

keepSessionAlive GET Interface

Method: GET

Relative URL: get-records/keep-session-alive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

Example Response:

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

changeEmLogger GET Interface

Method: GET

Relative URL: get-records/change-em-logger

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

Example Response:

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

getLoggedInUser GET Interface

Method: GET

Relative URL: get-records/get-logged-in-user

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field NameTypeDescription
responseUserDetails

Example Request:

Example Response:

{
   "id":112327147,
   "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":"?"
}

setReportExport POST Interface

Method: POST

Relative URL: get-records/export-reportdetail/reportid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
inputStringClass

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

getSearchNotifyWorkflow POST Interface

Method: POST

Relative URL: get-records/search-notify-workflow

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
popupSearchDataNotificationSearchPojo

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

GETSEARCHNOTIFYWORKFLOW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "module":"?",
   "searchFor":"?",
   "value":"?",
}

Example Response:

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

getSearchNotify POST Interface

Method: POST

Relative URL: get-records/search-notify

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
popupSearchDataNotificationSearchPojo

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

GETSEARCHNOTIFY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "module":"?",
   "searchFor":"?",
   "value":"?",
}

Example Response:

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

getSearchList POST Interface

Method: POST

Relative URL: get-records/search/db-class/db-property/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
popupSearchDataPopupSearch

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

getAllITSMProperties POST Interface

Method: POST

Relative URL: get-records/get-itsm-properties/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
roleSrchInputRoleSearch

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

getProductVersion GET Interface

Method: GET

Relative URL: get-records/get-product-version

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

Example Response:

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

generateExcelRecordsCMDBInThreadBlueprints POST Interface

Method: POST

Relative URL: get-records/cmdb-export-in-thread-blueprints/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputForRecordListFilterInputAndRecordList

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

GENERATEEXCELRECORDSCMDBINTHREADBLUEPRINTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "module":"?",
   "className":"?",
   "dbClassName":"?",
   "isDashboard":?,
   "sort": {
         "sortKey":"?",
         "sortOrder":"?",
         "propertyName":"?",
         "mapProperty":?
      },
   "filters":[
      {
         "display":"?",
         "filterKey":"?",
         "value1":"?",
         "value2":"?",
         "operator":"?",
         "dbPropertyType":"?",
         "mapProperty":?
      }   ],
   "records": {
         "scanId":?,
         "workflowId":?,
         "fromSACM":?,
         "customerId":"?",
         "userId":"?",
         "startTime":"?",
         "idList":[
            {
               "flag":?
            }         ]
      },
}

Example Response:

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

generateExcelRecordsCMDBInThread POST Interface

Method: POST

Relative URL: get-records/cmdb-export-in-thread/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

generateDiscoveredAssetsInThreadWizard POST Interface

Method: POST

Relative URL: get-records/get-excel-report-discovered-assets-wizard/page-number/limit/is-update-only

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputForRecordListFilterInputAndRecordList

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

GENERATEDISCOVEREDASSETSINTHREADWIZARD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "module":"?",
   "className":"?",
   "dbClassName":"?",
   "isDashboard":?,
   "sort": {
         "sortKey":"?",
         "sortOrder":"?",
         "propertyName":"?",
         "mapProperty":?
      },
   "filters":[
      {
         "display":"?",
         "filterKey":"?",
         "value1":"?",
         "value2":"?",
         "operator":"?",
         "dbPropertyType":"?",
         "mapProperty":?
      }   ],
   "records": {
         "scanId":?,
         "workflowId":?,
         "fromSACM":?,
         "customerId":"?",
         "userId":"?",
         "startTime":"?",
         "idList":[
            {
               "flag":?
            }         ]
      },
}

Example Response:

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

generateDiscoveredAssetsInThread POST Interface

Method: POST

Relative URL: get-records/get-excel-report-discovered-assets/page-number/limit/is-update-only

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

generateExcelRecordsInThread POST Interface

Method: POST

Relative URL: get-records/gen-excel-report-thread

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

generateExcelRecordsCMDB POST Interface

Method: POST

Relative URL: get-records/gen-excel-report-cmdb/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

generateExcelRecords POST Interface

Method: POST

Relative URL: get-records/gen-excel-report

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

moveToGroup POST Interface

Method: POST

Relative URL: get-records/move-to-group/group-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
idListRecordListForDelete

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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

verifyOTPSAML POST Interface

Method: POST

Relative URL: get-records/verify-otp-saml

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
mfaMFA

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

VERIFYOTPSAML 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "mfaEmail":"?",
   "otpEmail":"?",
   "mfaOTP":"?",
   "mfaResendOTP":"?",
   "mfaCustomerId":"?",
   "mfaType":"?",
   "mfaUserName":"?",
   "mfaToken":"?",
   "userId":"?",
   "mfaTwoFactorSecretKey":"?"
}

Example Response:

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

getAllSyncLogs POST Interface

Method: POST

Relative URL: get-records/get-all-synclogs/page-no/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
detailFilterInput

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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