XML element PageFilterSpec

Name: PageFilterSpec

Generic search request parameters used in the search query string

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.PageFilterSpec",
   "allStats": <Boolean>,
   "filterAttributeList": [SortFilterAttribute],
   "filterParams": MultivaluedMap,
   "limit": <Number>,
   "metric": <String>,
   "name": <String>,
   "offset": <Number>,
   "offsetType": 'POSITION' | 'NAME' | 'UUID' | 'INVALID',
   "offsetValue": <Object>,
   "page": <Number>,
   "qParams": MultivaluedMap,
   "QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAX": <Number>,
   "QUERY_TIMEOUT_IN_SEC_DEFAULT": <Number>,
   "QUERY_TIMEOUT_IN_SEC_MAX": <Number>,
   "queryType": 'TOP_DOCS_BY_TIME' | 'TOP_DOCS_BY_LATEST_TIME' | 'OFFSET_BY_TIME' | 'OFFSET_BY_SEQUENCE',
   "refresh": <Boolean>,
   "replLinkId": Uuid,
   "since": <Date>,
   "sortedBy": <String>,
   "sortOrder": <String>,
   "syslogForwarding": <String>,
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP',
   "timeout": <Number>,
   "until": <Date>,
   "uuid": <String>,
}

Name Type Description

allStats

xsd:boolean

**Query Param Info:**
Param Name:	allStats
Description:	'TRUE' indicates that all statistics should be returned. Used with'start' and 'until' for 'GET v310/vm'. Can be used with one or both parameters.
Multivalued:	No
Usage:	?allStats=value

filterAttributeList xsd:list[SortFilterAttribute] Iterates over all the @Filter query params and builds SortFilterAttribute objects from it. SortFilterAttribute wraps attribute name and String value; per mapped attribute.

filterParams MultivaluedMap

limit

xsd:int

**Query Param Info:**
Param Name:	limit
Description:	Number of items to be included in page
Multivalued:	No
Usage:	?limit=value

metric

xsd:string

**Query Param Info:** (VMstoreOnly)
Param Name:	metric
Description:	Performance metric of the requested resource to filter results. Possible values are: NONE, TIMESTAMP, PERFORMANCE_RESOURCE, THROUGHPUT, IOPS, LATENCY, CACHE_HIT_RATIO, USAGE, HOST_CPU_MEMORY, BYTES_REMAINING, REPLICATION_RATE, REPLICATION_RATE_INCOMING, MIGRATION_BYTES_REMANING, MIGRATION_RATE.
Multivalued:	No
Usage:	?metric=value

name xsd:string For query param info, refer to: name

offset

xsd:int

**Query Param Info:**
Param Name:	offset
Description:	Starting offset to paginate from.
Multivalued:	No
Usage:	?offset=value

offsetType

POSITION | NAME | UUID | INVALID

The offset type of 'offsetValue'.

POSITION	offsetType is a position in the page
NAME	offterType is a name string
UUID	offtestType is a name UUID
INVALID	offtestType is invalid

offsetValue xsd:any The offset value in the terms of 'offsetType'.

page

xsd:int

**Query Param Info:**
Param Name:	page
Description:	Requested page number. Starts at 1.
Multivalued:	No
Usage:	?page=value

qParams MultivaluedMap

QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAX xsd:int Max job completion timeout (in minutes)

QUERY_TIMEOUT_IN_SEC_DEFAULT xsd:int Default search timeout (in seconds)

QUERY_TIMEOUT_IN_SEC_MAX xsd:int Max search timeout (in seconds)

queryType

TOP_DOCS_BY_TIME | TOP_DOCS_BY_LATEST_TIME | OFFSET_BY_TIME | OFFSET_BY_SEQUENCE

TOP_DOCS_BY_TIME	sort top contributors by time based on since and until values
TOP_DOCS_BY_LATEST_TIME	sort top contributors by time based on latest update time
OFFSET_BY_TIME	sort by time starting with a time offset
OFFSET_BY_SEQUENCE	sort by offset starting with a page offset

**Query Param Info:**
Param Name:	queryType
Description:	The query type
Multivalued:	No
Usage:	?queryType=value

refresh

xsd:boolean

**Query Param Info:**
Param Name:	refresh
Description:	'TRUE' requests to return the latest information.
Multivalued:	No
Usage:	?refresh=value

replLinkId

Uuid

**Query Param Info:** (VMstoreOnly)
Param Name:	replLinkId
Description:	Replication Link ID in the form: <TGC VM Serial Number> - RPL - <TGC generated local sequence number>
Multivalued:	No
Usage:	?replLinkId=value

since

xsd:datetime

**Query Param Info:**
Param Name:	since
Description:	The start date in ISO8601 format - 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'
Multivalued:	No
Usage:	?since=value

sortedBy

xsd:string

**Query Param Info:**
Param Name:	sortedBy
Description:	Property name of the resultant DTO to sort on.
Multivalued:	No
Usage:	?sortedBy=value

sortOrder

xsd:string

**Query Param Info:**
Param Name:	sortOrder
Description:	The sort order, either 'ASC' or 'DESC'
Multivalued:	No
Usage:	?sortOrder=value

syslogForwarding

xsd:string

**Query Param Info:** (VMstoreOnly)
Param Name:	syslogForwarding
Description:	'*' value fetches ApplianceSyslogForwarding info.
Multivalued:	No
Usage:	?syslogForwarding=value

target

VM	Virtual machine
VDISK	Virtual disk
SNAPSHOT	Snapshot
JOB	Job
ALERTS	Alert
DATASTORE_STAT	Datastore statistics
VM_STAT	Virtual Machine statistics
VDISK_STAT	Virtual disk statistics
SERVICE_GROUP	Service group

**Query Param Info:** (VMstoreOnly)
Param Name:	target
Description:	The target resource to search for.
Multivalued:	No
Usage:	?target=value

timeout

xsd:long

**Query Param Info:** (VMstoreOnly)
Param Name:	timeout
Description:	Timeout value in milliseconds for the long poll.
Multivalued:	No
Usage:	?timeout=value

until

xsd:datetime

**Query Param Info:**
Param Name:	until
Description:	The end date in ISO8601 format - 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'
Multivalued:	No
Usage:	?until=value

uuid xsd:string For query param info, refer to: uuid