Schema for Search Resource

The schema for the Search resource contains the following elements:

Click this link to view the XSD file.

SearchQueriesType

Name

Type

Description

SearchQuery

SearchQueryType

Represents a search query in vCenter Chargeback Manager.

SearchQueryType

Represents a Search Query type in vCenter Chargeback Manager.

CriteriaType

Name

Type

Description

Filter

FilterType

Represents the search filter.

type

xs:string

Represents the search filter type.

FilterType

Name

Type

Description

name

xs:string

Name of the filter. See the Search Query Filters table the reference page for Search API for a list of filter names that you can use with each resource.

type

xs:string

Type of the filter. For more information on filter types, see the reference page for Search API.

value

xs:string

Value of the specified filter. For more information on filter values, see the reference page for Search API.

from

xs:string

Start range of the specified filter. For example, 1275034498970.

Mandatory only for the filter BETWEEN.

to

xs:string

End range of the specified filter. For example, 1275054498970.

Mandatory only for the filter BETWEEN.

SortByType

Name

Type

Description

Params

ParamsType

Represents the parameter type used for sorting search results.

ParamsType

Name

Type

Description

Param

ParamType

Represents the optional sorting parameter.

ParamType

Name

Type

Description

index

xs:int

Index of the sorting parameter. Index would be in the order in which the result needs to be sorted. Starts from 1.

order

xs:string

Sorting order. Valid value is ASC or DESC.

PaginationType

Name

Type

Description

FirstResultCount

xs:int

Mandatory parameter. Indicates the number from which the result is to be returned. You can specify a number between 0 and 299.

MaxResultCount

xs:int

Mandatory parameter. Indicates the maximum number of results to be returned. Specify a number between 0 and 300.

SearchResultsType

Name

Type

Description

SearchResult

SearchResultType

Represents the result of the search.

SearchResultType

Name

Type

Description

uuid

xs:string

Unique string ID for the given query. For example, 127524218244818350128.

FirstResultCount

xs:string

Search result number from which results are returned. For example, 0 to 299

MaxResultCount

xs:string

Maximum number of results returned.

totalResultCount

xs:string

Actual number of results for the given query.