Get Matching Resources Using POST
Gets a listing of resources based on the query spec specified
Page number from which data needs to be displayed (0-based)
Expected number of entries per page
Query spec that encapsulates various filtering criteria for looking up Resources
{
"adapterInstanceId": [
"string"
],
"adapterKind": [
"string"
],
"collectorId": [
0
],
"collectorName": [
"string"
],
"credentialId": [
"string"
],
"includeRelated": "string",
"maintenanceScheduleId": [
"string"
],
"name": [
"string"
],
"parentId": [
"string"
],
"propertyConditions": {
"conditions": [
{
"doubleValue": "number",
"key": "string",
"operator": "string",
"stringValue": "string"
}
],
"conjunctionOperator": "string"
},
"propertyName": "string",
"propertyValue": "string",
"recentlyAdded": 0,
"regex": [
"string"
],
"resourceHealth": [
"string"
],
"resourceId": [
"string"
],
"resourceKind": [
"string"
],
"resourceState": [
"string"
],
"resourceStatus": [
"string"
],
"resourceTag": [
{
"category": "string",
"name": "string"
}
],
"statConditions": {
"conditions": [
{
"doubleValue": "number",
"key": "string",
"operator": "string",
"stringValue": "string"
}
],
"conjunctionOperator": "string"
},
"statKey": "string",
"statKeyInclusive": false,
"statKeyLowerBound": "number",
"statKeyUpperBound": "number"
}Array of uuids that identify adapter instances
Array of Adapter Kind keys
Array of Collector Identifiers
Array of Collector names
Array of CredentialIDs
None null value specifies to include related resource ids of given relationship type in resource result. Uses the RelationshipType.representation value.
Array of {@link UUID} that identify Maintenance Schedules. Since vROps 6.1.0 release onwards, we don't support search and look up of Resources using Maintenance Schedules' identifiers.
Array of resource names to query for. NOTE: Currently, only single element supported
Array of UUID of object that are the parent resource in a parent child relationship
Object used to define filtering criteria based on multiple stats/properties with possibility to specify the conjunction operator
Name of property. Query only supports filtering for a single property.
Value of property. Omitting the property value will check for existence of the property name on the resource. NOTE: Use 'propertyConditions' to specify lookup of Resource using multiple properties.
Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.
Array of resource names in java regex format. NOTE: regex and name are mutually exclusive. If both are specified, name is given preference.
Array of resource health
Array of Resource Identifiers
Array of Resource Kind keys
Array of resource states
Array of resource data collection stats
Property used for tag filtering. NOTE: If specified, only the resources with the tags will be returned.
Object used to define filtering criteria based on multiple stats/properties with possibility to specify the conjunction operator
Name of resource StatKey to validate value is within a range. Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions NOTE: Use 'statConditions' to specify lookup of Resource using multiple stat keys.
Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to true
StatKey value matching range lower bound
StatKey value matching range upper bound
The Collection of Resources matching the specified query parameters
{
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"pageInfo": {
"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "string",
"totalCount": 0
},
"resourceList": [
{
"badges": [
{
"color": "string",
"score": "number",
"type": "string"
}
],
"creationTime": 0,
"credentialInstanceId": "string",
"description": "string",
"dtEnabled": false,
"extension": {
"anyObjects": [
{}
]
},
"geoLocation": {
"latitude": "number",
"longitude": "number"
},
"identifier": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"monitoringInterval": 0,
"monitoringIntervalMinutes": 0,
"monitoringIntervalSeconds": 0,
"relatedResources": [
"string"
],
"resourceHealth": "string",
"resourceHealthValue": "number",
"resourceKey": {
"adapterKindKey": "string",
"extension": {
"anyObjects": [
{}
]
},
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string",
"resourceIdentifiers": [
{
"identifierType": {
"dataType": "string",
"extension": {
"anyObjects": [
{}
]
},
"isPartOfUniqueness": false,
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string"
},
"key": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string",
"uniquelyIdentifying": false,
"value": "string"
}
],
"resourceKindKey": "string"
},
"resourceStatusStates": [
{
"adapterInstanceId": "string",
"resourceState": "string",
"resourceStatus": "string",
"statusMessage": "string"
}
]
}
]
}