Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: GetResultsQueryParameters

require(["esri/tasks/datareviewer/GetResultsQueryParameters"], function(GetResultsQueryParameters) { /* code goes here */ });

Description

(Added at v3.14)
Encapsulates data used for retrieving results from the reviewer workspace. Instances of this class define the size and content of featuresets returned by the getResults function in ReviewerResultsTask. Results returned from the getResults function are paged. You can control page size and which page to fetch using properties in this class.
See also

Samples

Search for samples that use this class.

Properties

NameTypeSummary
pageNumberNumberThe page number, zero based index, of the results to return.
pageSizeNumberThe number of items to list on a page.
returnFieldsArrayArray of field names.
sortByStringIndicates a field name by which to sort.
sortDescendingBooleanControls sort order.

Methods

NameReturn typeSummary
toJSON()ObjectReturns a JSON representation of an instance of GetResultsQueryParameters.
Property Details

<Number> pageNumber

The page number, zero based index, of the results to return.
Default value: 0

<Number> pageSize

The number of items to list on a page. Specify a value between 1-1000.
Default value: 5

<Array> returnFields

Array of field names. Use "*" to indicate ALL. Valid fields include:
  • recordId
  • objectId
  • subtype
  • category
  • sessionId
  • checktitle
  • resourceName
  • checkName
  • notes
  • severity
  • reviewStatus
  • reviewTechnician
  • correctionTechnician
  • verificationTechnician
  • reviewDateUtc
  • correctionDateUtc
  • verificationDateUtc
  • lifecycleStatus
Optional.

<String> sortBy

Indicates a field name by which to sort. The field must be included in returnFields. Optional.

<Boolean> sortDescending

Controls sort order. Optional.
Known values: true | false
Default value: false
Method Details

toJSON()

Returns a JSON representation of an instance of GetResultsQueryParameters.
Return type: Object