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 - UserGroupService Services

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

addUserGroup POST Interface

Method: POST

Relative URL: usergroup/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
usergroupUserGroup

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

ADDUSERGROUP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "groupEmail":"?",
   "archive":?,
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "manager": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "department": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "groupImage":"?"
}

Example Response:

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

editUserGroup POST Interface

Method: POST

Relative URL: usergroup/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
usergroupUserGroup

Response Structure:

Field NameTypeDescription
usergroupUserGroup

Example Request:

EDITUSERGROUP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "groupEmail":"?",
   "archive":?,
   "user":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "role":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "manager": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "department": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "groupImage":"?"
}

Example Response:

{
   "id":1596427228,
   "name":"?",
   "description":"?",
   "groupEmail":"?",
   "archive":?,
   "user":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "role":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "manager": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "department": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "uniqueId":"?",
   "groupImage":"?"
}

getAllUserGroup GET Interface

Method: GET

Relative URL: usergroup/getallusergroup

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field NameTypeDescription
usergroupListValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":1621293254,
         "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":?
      }   ]
}

getAllUserGroupDetails POST Interface

Method: POST

Relative URL: usergroup/get-all-usergroup-details/page-number/number

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
filterInputFilterInput

Response Structure:

Field NameTypeDescription
arrayOfUserGroupDetailsArrayOfUserGroupDetails

Example Request:

GETALLUSERGROUPDETAILS 
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":1585773101,
         "display":"?",
         "filterKey":"?",
         "value1":"?",
         "value2":"?",
         "operator":"?",
         "dbPropertyType":"?",
         "mapProperty":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "totalResults":?,
   "filterRuleList":[
      {
         "id":2147483647,
         "filterKey":"?",
         "filterValue":"?",
         "operatorDisplayName":"?"
      }   ],
   "responseList":[
      {
         "id":2147483647,
         "name":"?",
         "description":"?",
         "groupEmail":"?",
         "archive":?,
         "user":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "role":[
            {
               "id":2109966429,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "createdOn":?,
         "lastModifiedOn":?,
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "manager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "department": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "uniqueId":"?",
         "groupImage":"?"
      }   ]
}

addAssociatedUsers POST Interface

Method: POST

Relative URL: usergroup/add-associated-users

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field NameTypeDescription
associatedUsersIntegerList

Response Structure:

Field NameTypeDescription
responseResponse

Example Request:

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

Example Response:

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