SearchResults class
The SearchResults class represents the object returned by a search request.
SearchResults class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the SearchResults class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
search | POST | Searches for SearchResults objects. |
Operation APIs
The SearchResults class has no operation APIs.
Relationship APIs
The SearchResults class has no relationship APIs.
SearchResults class relationships and attributes
The following tables list the relationships and attributes of the SearchResults class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
propertyAggregations | CsmStatistics | 0..* |
|
results | 0..* | Results returned by the search. The type is the same as the type of cloud object for which you searched. | |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
pageNo | Integer | 1 | Page number within the set of search results |
pageSize | Integer | 1 | Number of returned objects on the page |
providerUri | String | 1 | Provider URI |
totalRows | Integer | 1 | Number of objects returned by the search |
description | String | 0..1 | Text that describes the object |
guid | String | 1 | Globally unique identifier for the object |
labels | String | 0..* |
|
modifiedDate | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |