Perform Global Search
This operation returns global search response similar to Command center.
Query Parameters
- name string required
string to be searched
Header Parameters
- EnumNames string required
A flag indicating how enum values should be represented in the response. When set to 0, enum values are returned as their corresponding integer values. When set to 1, enum values are returned as their descriptive names (enum strings).
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Search response for string 'entity' with header "enum Names"= 0
- Search response for string 'test' with header "enum Names"= 1
Schema
entitySearchResultInfo object[]
{
"entitySearchResultInfo": [
{
"totalMatchingEntityCount": 0,
"entityInfo": [
{
"displayName": "string",
"name": "string",
"commcellGuid": "string",
"id": "string",
"detailedProperty": {}
}
]
}
]
}
{
"entitySearchResultInfo": [
{
"searchType": 16,
"totalMatchingEntityCount": 2,
"entityInfo": [
{
"displayName": "duplicate entity - company 1722001984",
"name": "duplicate entity - company 1722001984",
"commcellGuid": "E601384E-1745-4317-B636-4EC38C7B5603",
"id": "1044",
"detailedProperty": {
"companyProperty": {
"providers": {
"serviceType": 5,
"ownerCompanyName": "Commcell",
"providerGUID": "720190c6-adc3-4926-88c3-0b8bc907b3a3",
"agePasswordDays": 0,
"isCloudServiceCompany": false,
"ownerCompanyId": 0,
"enableLocalAuthentication": 0,
"connectName": "duplicate entity - company 1722001984",
"canCreateCompanies": false,
"status": 1,
"flags": 0,
"loginSessionTimeoutInMinutes": 0,
"sharedInfraDetails": {},
"primaryContacts": [
{
"fullName": "user98920",
"user": {
"userId": 2179
}
}
],
"office365Settings": {},
"shortName": {
"domainName": "cvlt90529",
"id": 1044
},
"provider": {
"_type_": 61,
"providerId": 1044
},
"emailDomainNames": [
"cvlt90529.com"
],
"commcell": {
"commCellName": "lhotse",
"entityInfo": {
"multiCommcellName": "lhotse"
}
}
}
}
}
},
{
"displayName": "duplicate entity - company 1722000427",
"name": "duplicate entity - company 1722000427",
"commcellGuid": "E601384E-1745-4317-B636-4EC38C7B5603",
"id": "1041",
"detailedProperty": {
"companyProperty": {
"providers": {
"serviceType": 5,
"ownerCompanyName": "Commcell",
"providerGUID": "f29c322b-4f75-4c8e-99aa-89ffd2350593",
"agePasswordDays": 0,
"isCloudServiceCompany": false,
"ownerCompanyId": 0,
"enableLocalAuthentication": 0,
"connectName": "duplicate entity - company 1722000427",
"canCreateCompanies": false,
"status": 1,
"flags": 0,
"loginSessionTimeoutInMinutes": 0,
"sharedInfraDetails": {},
"primaryContacts": [
{
"fullName": "user81539",
"user": {
"userId": 2174
}
}
],
"office365Settings": {},
"shortName": {
"domainName": "cvlt38556",
"id": 1041
},
"provider": {
"_type_": 61,
"providerId": 1041
},
"emailDomainNames": [
"cvlt38556.com"
],
"commcell": {
"commCellName": "lhotse",
"entityInfo": {
"multiCommcellName": "lhotse"
}
}
}
}
}
}
]
},
{
"searchType": 10,
"totalMatchingEntityCount": 2,
"entityInfo": [
{
"displayName": "duplicate entity - plan1722002005",
"name": "duplicate entity - plan1722002005",
"commcellGuid": "E601384E-1745-4317-B636-4EC38C7B5603",
"id": "96",
"detailedProperty": {
"planProperty": {
"plan": {
"planSummary": "RPOHours:4,NumberOfCopies:1,PrimaryStorageRetention:1 Month,PrimaryStorageType:Disk",
"planName": "duplicate entity - plan1722002005",
"planId": 96,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
},
"globalConfigInfo": {}
}
}
}
}
]
},
{
"searchType": 2,
"totalMatchingEntityCount": 2,
"entityInfo": [
{
"displayName": "duplicate entity - clientgroup 1722002000",
"name": "duplicate entity - clientgroup 1722002000",
"commcellGuid": "E601384E-1745-4317-B636-4EC38C7B5603",
"id": "1209",
"detailedProperty": {
"serverGroupProperty": {
"groups": {
"flag": 0,
"isCommcellGroup": false,
"groupAssocType": 3,
"isSmartClientGroup": false,
"name": "duplicate entity - clientgroup 1722002000",
"Id": 1209,
"isCompanySmartClientGroup": false,
"clientGroup": {
"clientGroupId": 1209,
"clientGroupName": "duplicate entity - clientgroup 1722002000",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
},
"globalConfigInfo": {}
},
"discoverRulesInfo": {
"syncStatus": 0
}
}
}
}
}
]
}
]
}
{
"entitySearchResultInfo": [
{
"searchType": "WORKFLOWS",
"totalMatchingEntityCount": 4,
"entityInfo": [
{
"displayName": "DeleteStoragePolicyAuthorization",
"name": "DeleteStoragePolicyAuthorization",
"commcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"id": "112",
"subtype_id": "0"
},
{
"displayName": "DeleteStoragePolicyCopyAuthorization",
"name": "DeleteStoragePolicyCopyAuthorization",
"commcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"id": "122",
"subtype_id": "0"
},
{
"displayName": "Network Test Tool",
"name": "Network Test Tool",
"commcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"id": "84",
"subtype_id": "0"
},
{
"displayName": "UpdateStoragePolicyCopyAuthorization",
"name": "UpdateStoragePolicyCopyAuthorization",
"commcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"id": "141",
"subtype_id": "0"
}
]
},
{
"searchType": "USER",
"totalMatchingEntityCount": 1,
"entityInfo": [
{
"displayName": "test",
"name": "test",
"commcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"id": "52",
"detailedProperty": {
"userProperty": {
"users": {
"serviceType": "COMMSERVE",
"istfaEnabled": false,
"isMFAAuthenticatorRegistered": false,
"isMFAPasswordlessAllowed": false,
"agePasswordDays": 0,
"numDevices": 0,
"UPN": "test@1.com",
"failedLoginAttemptsSinceLastLogin": 0,
"userFlags": 1,
"failedLoginAttempts": 0,
"authenticationMethod": "LOCAL",
"enableUser": true,
"isLoginBackupCodeEnabled": false,
"isAccountLocked": false,
"description": "",
"isMFAEnabled": false,
"email": "test@1.com",
"lastFailedLoginAttemptTime": 0,
"lastLogIntime": 0,
"isMFAPlatformAuthenticatorsOnly": false,
"isLaptopUser": false,
"fullName": "test",
"isMFAUsernamelessAllowed": false,
"isPrimaryContact": false,
"userProps": {
"nameValues": [
{
"name": "datePasswordSet",
"value": "1709801102"
}
]
},
"sensitiveProps": {
"salt": "c3ce3c091301428f788dbf9d046048a1773315a52cd5ecd5ae13d459d0864548",
"hashPassword": "76bcf0ec74585f0afc937d4bcc3eb03df0484e3007ff9dab69cb546c968719b34"
},
"plan": {},
"userEntity": {
"userGUID": "EDD6417C-903B-4F6D-897B-9E802AFFF2B0",
"userName": "test",
"userId": 52,
"entityInfo": {
"companyId": 0,
"multiCommcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"multiCommcellName": "ec-auto-cs",
"companyName": "Commcell"
}
},
"loginInfo": {},
"provider": {
"providerId": 0
}
}
}
}
}
]
},
{
"searchType": "ROLE",
"totalMatchingEntityCount": 1,
"entityInfo": [
{
"displayName": "test_role",
"name": "test_role",
"commcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"id": "120",
"detailedProperty": {
"roleProperty": {
"role": {
"roleId": 120,
"roleName": "test_role",
"entityInfo": {
"companyId": 0,
"multiCommcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"multiCommcellName": "ec-auto-cs",
"companyName": "Commcell"
},
"flags": {
"disabled": false
},
"globalConfigInfo": {}
}
}
}
}
]
},
{
"searchType": "SERVERGROUP",
"totalMatchingEntityCount": 1,
"entityInfo": [
{
"displayName": "test_sg_1",
"name": "test_sg_1",
"commcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"id": "47",
"detailedProperty": {
"serverGroupProperty": {
"groups": {
"flag": 0,
"description": "",
"isCommcellGroup": false,
"groupAssocType": "MANUAL",
"isSmartClientGroup": false,
"name": "test_sg_1",
"Id": 47,
"isCompanySmartClientGroup": false,
"clientGroup": {
"clientGroupId": 47,
"clientGroupName": "test_sg_1",
"entityInfo": {
"companyId": 0,
"multiCommcellGuid": "A24B25A0-092E-43BC-9CDD-988303702BD0",
"multiCommcellName": "ec-auto-cs",
"companyName": "Commcell"
},
"globalConfigInfo": {}
},
"discoverRulesInfo": {
"syncStatus": 0
}
}
}
}
}
]
}
]
}
GET /entities/search
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Entities/search' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Entities/search' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Entities/search' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Entities/search' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Entities/search' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Entities/search' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Entities/search' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'