XML element UserRoleFilterSpec

Name: UserRoleFilterSpec

A FilterSpec for UserRole pagination. Current uses is in the GET /v310/role/external/filter endpoint.

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.UserRoleFilterSpec",
   "absTotal": <Number>,
   "overflow": <Boolean>,
   "refresh": <Boolean>,
   "sessionKey": <String>,
   "allStats": <Boolean>,
   "limit": <Number>,
   "metric": <String>,
   "name": <String>,
   "offset": <Number>,
   "page": <Number>,
   "queryType": 'TOP_DOCS_BY_TIME' | 'TOP_DOCS_BY_LATEST_TIME' | 'OFFSET_BY_TIME' | 'OFFSET_BY_SEQUENCE',
   "replLinkId": Uuid,
   "since": <Date>,
   "sortedBy": <String>,
   "sortOrder": <String>,
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP' | 'GENERIC_INTERFACE' | 'APPLIANCE' | 'VIRTUAL_VMSTORE',
   "timeout": <Number>,
   "until": <Date>,
   "uuid": <String>,
}

Name Type Description

allStats xsd:boolean For query param info, refer to: allStats

limit xsd:int For query param info, refer to: limit

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

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

offset xsd:int For query param info, refer to: offset

page xsd:int For query param info, refer to: page

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

For query param info, refer to: queryType

replLinkId Uuid For query param info, refer to: replLinkId

since xsd:datetime For query param info, refer to: since

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

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

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
GENERIC_INTERFACE	Generic Interface
APPLIANCE	Appliance
VIRTUAL_VMSTORE	Virtual VMstore

For query param info, refer to: target

timeout xsd:long For query param info, refer to: timeout

until xsd:datetime For query param info, refer to: until

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

Attributes
Name	Type	Description
absTotal	xsd:long	The total number of external group search results used for paginiation.
overflow	xsd:boolean	True means search result contain all entries.
refresh	xsd:boolean	Refresh the external groups cache. For query param info, refer to: `refresh`
sessionKey	xsd:string	The session key used to cache the paginated external groups result.