The Virima API

Version: 5.11

Last Updated: 24 Dec 2024 07:03:05 GMT

Introduction

This section provides demonstrative information on Virima APIs associated with Discovery, ITSM, and ITAM Records. Virima provides access to APIs to perform Inbound and Outbound operations on the instance data. This information is prepared for a User(s) possessing basic knowledge on usage of REST APIs. It is highly recommended that users contact Virima before embarking on using APIs as API Key and Tenant ID need to be created by Virima beforehand.

Use of the API is via the HTTP protocol. The GET, POST, PUT, and DELETE requests are all used, with standard interpretations for the protocol - POST usually creates, PUT updates, DELETE deletes, and GET reads a record or records. Construct representations are in JSON.

The API presupposes no particular structure in the URI space. The starting point is a URI, supplied by Virima. The specification of the Virima API includes:

Common behaviors that apply across all requests and responses.
Construct models, which describe the JSON data structures used in requests and responses.
The requests that may be sent to Virima, and the expected responses.

This API operates on the following primary resource types:

TimescaleNotifications: sla notifications
SAMLConfiguration:
ServiceDesignPackage:
SLA:
AzureAdConfiguration:
AzureAdImportSchedule:
ADImportSchedule:
ADImportScheduleReports:
AzureADImportScheduleReports:
LDAPImportScheduleReports:
AgentCorrelator:.
AgentResourceMonitor:.
BasicDetail:.
MultiMapAndroid: the multi valued map.
DataInputAndroid: the data.
NotificationSearchPojoAndroid:.
EditTimescaleAndroid:Edit Timescales POJO
RecordRelationArrayAndroid:.
FilterInputAndroid:the ArrayList
StringInputAndroid:the strings
PopupSearchAndoid: .
EditValueCmdbArrayAndroid:.
MobileManagement:.
Announcement:the AnnouncementService
HardwareAssets:the HardwareAssets.
Consumables:the Consumables.
SoftwareLicenseAssets:the SoftwareLicenseAssets.
OtherAssets:the OtherAssets.
AssetLicenseEntitlements:the Asset License Entitlements.
UserLicenseEntitlements:the User License Entitlements.
StockRoom:the StockRoom.
StockRoomType:the Stock Room Type.
NewHardwareAsset:the HardwareAssets.
HardwareGroup:
AddNewHarwareProperty:.
HardwareStock:Stock
AssetAudits:
IntegersBooleanClass:
MaintainanceHistory:
BSMViews:
BusinessProcess:the businessprocess
ServiceOffer:the businessprocess
InScope:the businessprocess
OutScope:the businessprocess
Outages:the businessprocess
Commitment:the businessprocess Commitment
CommitmentSchedule:the businessprocess CommitmentSchedule
Availability:the businessprocess Commitment
BusinessProcessCIs:
ArrayOfInScope:the array Inscope
IntegerIds:
ArrayOfId:the array Task
ArrayOfOutScope:the array Outscope
ArrayOfCommitments:the array commitments
CherwellCredential:cherwell credentials
CherwellMapping:
CherwellMappingArray:
CherwellMappingCondition:
EditValueCmdb:
EditValueCmdbArray:.
CIResults:.
CIResultSet:.
AddComponent:.
CISnapshot:.
AddNewProperty:.
SearchLicenseKeys:
ConfidenceLevel:
ConfidenceLevelList:
BluePrint:.
BluePrintObject:.
RelationshipTypes:
ImportRelationshipType:
Rescan:Rescan form the CMDB page
SaveRelationView:Save Relationship view
CIAudits:CI Audits
CIParentAudits:CI Audits
CIChildAudits:CI child Audits
ADMConfiguration:
SoftwareLicenceNotification:software license notification
EditCIRelationshipType:Edit CI Relationship from BSM View
FilterInputRelation:FilterInputRelation
CIExportTemplate:CIExportTemplate
BlueprintPropertyArray:BlueprintPropertyArray
BlueprintPropertyList:BlueprintPropertyList
CIMaintenance: shows maintenance of CI
CIContacts:ci contacts
CIContracts:ci contracts
SoftwareLicenseGroups:Software LicenseGroups
PortConfigurationForProcess:ci contacts
CIWarranty:ci warranty
IPConnectionScoreThreshold:
CmdbAudit:
Comment:Comment Details
Comments:Comments
ArrayOfComment:the array Task
Credential: the user.
ResetPassword: post for reset password
RoleSearch: the user.
MultiMap: the multi valued map.
MultiMapList: the multi valued map.
MultiMapForCIChangeAttributes: the multi valued map.
PopupSearch: .
Map: the response.
Response: the response.
DiscoveryResponse: the response.
DeleteRequest: the response.
UpdateRecord: the Update Record.
RecordID: the Record ID.
RecordList:the project
RecordListForDelete:the project
ID: the Record ID.
RecordLists: the Record ID.
PVersion: the Product Version.
UpdateRecordType: the Update Record.
TransactionMessage: the trasaction details.
TransactionMessageForMove: the trasaction details.
DataInput: the data.
ArrayOfUsers:the project
ArrayOfBluePrints:thelist of blue prints.
ArrayOfResponse:the list Response
ListOfString:the project
StringClass:the string
ReportClass:the string
ExistingQuestion:the string
ReportStringClass:the string
CompStringClass:the string
filterOperatorList:the project
ValueList:the project
CompValueList:the project
AddComp:the project
AddCompStringClass:the StringClass
ValuePojo:the project
intList:the integer list
intval:the inter value
AttachmentPojo:
ArrayAttachList:Array of Files
StringInput:the strings
StringInputForCi:the strings
SearchResult:the
StringClassTwo:the strings
SearchClass:the
EditValues:
EditValuesArray:.
ImportCIDetails:.
ImportITILDetails:.
AddNewITSMProperty:.
AttributeDetail:.
ChangeWorkflow:.
ChangeCIOutage:.
ChangeCIOutageArray:.
ChangeProposal: the change proposal Pojo
ChangeCABMeeting:
ReleaseActivity:
ChangeReview:
Escalate: post for escalation
CommonProperty:common property
SetTag:set the tags
SetTagForMultipleConditions:set the tags
TagConditions:set the tags
StringList:
IntegerList:
TwoIntegerLists:
TwoLongLists:
LearnMoreNotification: Notification for learn more
SetUpWizard:Initial set up wizard of EM
SampleInput:Sample input for API Examples
PropertyData:Properties
ImportData:the project
ImportCITemplate:
AdvancedSearchInput:the ArrayList
AdvancedSearchPojo:the ArrayList
ResetADPassword: post for AD reset password
EscalationConfiguration: this pojo specifies auto escalation configurations
StringPojo:the project
StringPojoArray:Array of String Pojo
AddNewITAMProperty:.
ApplyChangeParameter:Apply change details.
PropertyName:Property.
PropertyList:Property List.
PropertyGroup:Group.
GroupList:Group List.
GroupProperty:Group.
CustomizedColumn:CustomizedColumn
Contract:
NewContract:
ContractGroup:
Correlator:Correlation Changes to Show in Blueprint History
CostCenter:
Credentials:the credential
ArrayOfCredential:the credentials
CustomReport:
ParametersList:list of parameters
Customer:the customer
ImportCustomerDetails:the customer
ServiceNowCredential:Servicenow credentials
InfoBloxCredential:InfoBlox credentials
AddCustomer:the customer
Holiday:holidays
OperationalHour:
OperationalHourArray:.
ArrayOfCustomers:the customers.
AddMSPCustomer:the customer
storageTypeData:.
CyberArk:
Demand:
DiscoverPattern:.
IgnoreProcess:.
SoftwareCommandRegex:.
Property:.
Record:.
RecordSimple:.
RecordForChangeAttribute:.
Records:.
RecordBluePrint:.
EditProperty:
DeleteProperty:
EditValue:
EditValueArray:.
RecordRelation:
RecordRelationArray:.
RecordRelationFilter:Filter for getting CMDB relationships
DiscoveryRecord:.
CIPartInput:.
CIPartFilterInput:.
DeleteRecordInputs:.
DeletComponent:.
DiscoveryIDs:.
AWSPojo:.
AZUREPojo:.
DiscoveryIPConnection:.
CorrelationInput:Inputs needed for correlation function
CorrelationArrayList:Inputs needed for correlation function
CorrelationRuleInput:Rules for the discovery record correlation
CorrelationRuleInputList:Inputs needed for correlation function
CorrelationRule:Rules for the discovery record correlation
CorrelationRuleBP:Rules for the discovery record correlation
CorrelationRuleArray:Rules for the discovery record correlation
DiscoveryMonitoringProfile:
ExternalAlert:
ExternalAlertEmail:
ExternalAlertAction:
MailBoxConfiguration:
ExternalAlertCondition:
MailData:
FileOrDirectory:
MailBoxConfigurationList:
DiscoveryComponentRefresh:Fields for refresh discover item component
DiscoverPlatformDetectionOrder:ports for discovering device type
DiscoverPlatformDetectionOrderList:
CredentialConfiguration:
CIObjectForRelation:.
AgentSelfScanOutput:.
MSWindowsUpdates:.
MSWindowsUpdate:.
IPAMRecord:.
PaexecConfigurationParameter:.
PaexecConfiguration:.
MerakiPojo:.
ScheduleScansAndImportsPojo:.
IntunePojo:.
DiscoveryClient:the discovery client
ArrayOfDiscoveryClient:the credentials
updateClinetByStateInput:the discovery client
updateClinetByCurrentStatusInput:the discovery client
DiscoveryInputGeneric:The generic input specifier for most discovery updates
StringInputforDiscoveryAgent:the strings
ClientSessionIdentifier:
CronExpressionPojo:
UpdateClientSessionAgent:
AgentAlarmConf:
DiscoveryBuildAgent:
DiscoveryScan:the discovery scan
DiscoveryScheduleScan:the discovery scan
DiscoveryAgentInstall:the discovery scan
RecordDocParameter:the associate Doc parameter
SentItem:
ReceivedItem:
SentItemArray:the roles.
ReceivedItemArray:the roles.
EmailPreference:the Task
ArrayOfPreference:the array preference
Mail:
Event:
AlertTemplate:
SavedAlert:
Alert:
federationInput:Federationinput
FinancePlan:
GroupProbe:the group probe
HomePageLinks:.
HTTPResponse:Http Response
UnfuddleTicket:Http Response
ImpersonateUser:the user
ImpersonateLogin:the user
Incident:the incident
ReleaseData:the release
cmdbAssetList:the cmdb asset name
cmdbAsset:the projects.
IncidentPriorityPOJO:Incident Priority POJO
IncidentPriorityList:List of Incident Priority POJO
EditIncidentPriority:Edit Incident Priority POJO
EditIncidentPriorityList:List of Edit Incident Priority
Timescale:Incident Timescale POJO
TimescaleList:Timescale POJO
EditTimescale:Edit Timescales POJO
EditTimescaleList:List of Edit Timescales
SearchPojo:.
ITILMetric:
NotificationSearchPojo:.
InfoBlox:the INFOBLOX
InfoBloxScheduleSync:the infoblox scan
IPAMSubnetProperties:the infoblox subnet properties
IPAMIPProperties:the infoblox ip properties
IPAMSubnets:the infoblox subnets
IPAMIPList:the infoblox ip list
IPAMIPSubnets:the infoblox ip subnet
ScheduleIPAMStatusUpdate:
IPAMStatusUpdate:
InfoBloxScheduleScanStatus:the infoblox scan
ChangeITSM: the change Pojo
ArrayOfChanges:the changes.
ITSMTicketMgtInboxProperties:
ITSMTicketMgtSMTPProperties:
IvantiCredential:ivanti credentials
IvantiFields:ivanti fields
IvantiSubTypeDetails:ivanti subtype
IvantiMapping:
IvantiMappingArray:
IvantiMappingCondition:
JiraCredential:jira credentials
JiraMapping:jira mapping
JiraMappingCondition:
JiraIDAndNameDetails:ivanti subtype
JiraIncidentAndChangeMapping:ivanti subtype
IntegrationProps:
KnowledgeManagement:the Knoweldge manegement
ArticleRating:the Knoweldge article rating
FileProperty:the file property
KnowledgeSubmission:the Knoweldge base submission
Location:the LocationService
LocationsList:
MajorSoftware:major software
MFA:MFA Details
AddMsp:the msp
MSPMailBoxConfiguration:
MSPEmailTemplate:
MSPSAMLConfiguration:
MoveRecordToCustomers:
MSPClient:the msp client
addOwner:the owner
ArrayOfOwner:the array owner
RelationTypes:
Preprocessor:the Preprocessor.
Probe:the risk.
ProbeValueList:the probe
ProbeList:
Problem:the problem
Requests: the Requests
RequestedItem: the Requested Item
TransferOrder: the Transfer Order
PurchaseOrder:the Purchase Order
PurchaseOrderLineItems:the Purchase Order Line Items
ReceivingSlip:the Receiving Slip
ReceivingSlipsLines:the Receiving Slips Lines
Program:the program
ProjectTaskInfo:the project - task information
TaskInfo:the task information
PopupProjTemp: .
PopupProjForTemp: .
Project:the project
AddTemplate:adding template
ArrayOfProjects:the projects.
ArrayOfProject:the projects.
TemplatePojo:the projects.
CloneProject:the projects.
ProjectTask: the project tasks
ArrayOfProjectTasks:Project Tasks.
SingleTaskPojo:Project Task.
TaskPredecessorPojo:the projects.
TaskAssignePojo:the projects.
ArrayOfAssignees:Assignees.
ProjectTaskTimeTracking:Project Tasks time tracking.
ReleasePojo:
Reporting:the Report
MSPReport:the Report
ReportingOrder:the Report order
ReportingDisplay:the Report order
ReportingClause:the Report clause
ReportPresentation: Report Presentation Layer
SemanticItemList:the project
ModuleList:the modules
TableList:the tables
ColumnList:the columns
ArrayOfReportClause:the report clause.
ArrayOfReportOrder:the report order.
DelRepInDBoard:the reports to be deleted in dash board.
AssessmentMaster:the survey
AssessmentQuestion:the survey
QuestionChoice:the survey
AssessmentThreshold:the survey
AddRisk:the risk.
Risk:the risk.
Docs:the risk.
Histroy:the risk.
ArrayOfRiskProperties:the project
RiskProperties:the .
ArrayOfRisks:the project
ArrayOfRecords:the of recordst
FilterRule:the project
ArrayOfInteger:the ArrayList
FilterInput:the ArrayList
SaveFilterInput:the ArrayList
AddFilterInput:the ArrayList
FilterOutput:List Of Rule
Filters:List Of Rule
FilterPojo:the ArrayList
SortPojo:the ArrayList
IntegerClass:the ArrayList
RiskDetails:the project
RiskScore:Risk Score
RiskScoreList:Risk Score List
FilterInputAndRecordList:the ArrayList
EditValueRoleAccess:
EditValueRoleAccessArray:.
RoleAccessEntity:.
Rule:the rule
UpdateRule:the rule with rule id
ArrayOfRules:the list of rules.
Action:the action
Criteria:the criteria
RunBook:the RunBook
RunBookTask:the RunBook task
ArrayOfRunBookTask:the tasks
ScanName:Apply change details.
ListOfScanName:Apply change details.
ScanRecord:Apply change details.
ListOfScanRecord:Apply change details.
ScanReportSummary:Scan report summary pojo
ScanHostReport:Scan report summary for each host
ScanHostReportArray:Rules for the discovery record correlation
CertificateDetails:Scan report summary for certificates
SearchInput:Searchinput
Sensor:the sensor
ServiceCatalogItem:the ServiceCatalogItem
Category:the Category
OrderItemLink:the OrderItemLink
ExecutionPlan:the ExecutionPlan
ExecutionPlanTasks:the ExecutionPlanTasks
AddRequestItemFromSC:
CartItem:
CartItemsArray:.
ProductModels:the ProductModels
IncReqProperty:.
PropertyArray:.
ServiceNowMapping:
ServiceNowMappingArray:
ServiceNowRecord:
SoftwareMetric:
KeyValue:
SoftwareMetrics:the survey
SurveyMaster:the survey
SurveyQuestion:the survey
SurveyResponse:the survey responses
SurveyInstance:the survey instances
Tags:Tags
addTask:the Task
CIEditTask:the Task
UpdateTask:the Task
Task:the Task
ArrayOfTask:the array Task
IntegerType:
ArrayOfTaskId:the array Task
TaskTimeTracking: time tracking details for tasks
TimeTrackExportReport: time tracking details
TimeTrackScheduleReport: time tracking schedule details
TimeTracking:TimeTracking
ArrayOfTimeTracks:the time tracking
ArrayOfUCFElements:Array Of UCF Elements
UCFElement:UCF Element
ADProperty: the property details.
UserGamification:the UserGamification
UserDetails: the user.
UserGroup:the UserGroup
UserInfo: the user Info.
UserRole: the User Role
Password: the User password
EntityObject: the User Role
ArrayOfEntity:the roles.
ArrayOfUserRole:the roles.
ArrayOfDepartment:the departments.
ArrayOfUserDetails:the user details.
ArrayOfUserGroupDetails:the user group details.
UserDepartment:the User Department
UserRequest:the User Request
UserIncident:the User Incident
LDAPPojo:
LDAPMapPojo:
LoggedInInfo:
Vendor:
NewVendor:
VendorGroup:
AddNewVendorProperty:.
Workflow:
WorkflowNew:
WorkflowCondition:
WorkflowTransition:
WorkflowBlock:
WorkflowTransitionBlock:
ArrayOfWorkflows:workflows
ArrayOfWorkflowBlocks:blocks
Menu:
MenuItem:
URLString:.
TemplateElement:.
Template:.
ListOfURLObject:.
URLObject:

Specifications

This guide consists of various sections, beginning with common behaviors and construct models, and individual sections for each service specified.