Query entities
get
/serviceapi/entityModel/data/entities/license
Gets the license details of entities.
API View: Standard
Request
Supported Media Types
- application/json
Query Parameters
-
addOnPackage(optional): string
the Add on package of the entities to be looked up
-
displayNamePattern(optional): string
the displayNamePattern of the entities to be looked up
- entityName(optional): array
- entityNamePattern(optional): array
- entityType(optional): array
-
licensePackage(optional): string
the license package of the entities to be looked up
-
limit(optional): integer(int32)
the number of entries in the result to be returned in one REST callDefault Value:
2000
-
offset(optional): integer(int32)
the offset into the result list when doing a query with limitDefault Value:
0
-
orderBy(optional): string
a comma separated list of attributes with order (asc/desc) to be used for ordering the returned entities.Accepted attributes: entityType, entityName
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : schema
Type:
Show Source
array
-
Array of:
object LicenseEntityQueryResponse
Describes output for REST end point to query the license details of entities for a tenant.
Nested Schema : LicenseEntityQueryResponse
Type:
object
Describes output for REST end point to query the license details of entities for a tenant.
-
addOnPackage(optional):
string
The Add On Package
API View: Standard
Example:PREMIUM
-
entityName(optional):
string
The Entity Name
API View: Standard
Example:MyLinuxHost
-
entityType(optional):
string
The Entity Type
API View: Standard
Example:omc_host_linux
-
licensePackage(optional):
string
The license package
API View: Standard
Example:ENTERPRISE