Retrieving record instances using REST API

dataPageType

• Specifies the fully qualified class name of the RecordInstanceDataPageQuery.
• This is a mandatory query parameter. 

Note: Do not change the value of this parameter.

pageSize

• Specifies how many records should be fetched in this page.
• This is a mandatory query parameter.

startIndex

• Specifies the first record's index of the "page".  
• This is a mandatory query parameter.

For example:

• If startIndex=0 and pageSize=50, the dataPageQuery will return the first 50 records from the dataset.  
• If startIndex=50 and pageSize=50, then the dataPageQuery will return the records 50 - 100 from the dataset.
• If startIndex=500 and pageSize=50, then the dataPageQuery will return the records 500 - 550 from the dataset.
• If pageSize=-1, then all records are returned. Be careful when using this option because it may return a very large number of records.

recorddefinition

• Specifies the name of the record definition.
• This is a mandatory query parameter.

propertySelection

• Specifies the list of comma separated properties which should appear in the response object, that is, the DataPage.data.

• The propertySelection parameter accepts numeric fieldIds.

• This is an optional query parameter.

For example,

sortBy

• Specifies the list of comma separated properties by which data should get sorted.
• The sortBy parameter accepts numeric fieldIds.
• To indicate descending sort, prefix the value with hyphen (-).
• This is an optional query parameter.

For example:

• To sort the data in an ascending order, specify the setting as sortBy = 1,2.
  This means that the data is sorted in the ascending order of property ID 1 then by 2.
• To sort the data in a descending order, specify the setting as sortBy=-3,-7.
  This means that the data is sorted in the descending order of property Id 3 then by status.
• To sort the data in an ascending and descending order, specify the setting as sortBy=1,-3,7.
  This means that the data is sorted in the ascending order of property Id 1 then by descending order of property Id 3 and
   then by ascending order of property status.

fieldId

• Specifies the filtering condition of the query, using field IDs of the record definition.
• You can specify multiple name-value pairs and the relational qualification between these name-value pairs is always set as AND.
• This is an optional query parameter.

For example:

• &7=new
  This means that retrieve only those records whose 'status' field's value is new.
• &7=new&name=Jack
  This means that retrieve only those records whose 'status' field's value is new and 'name' field's value is Jack.

queryExpression

• Specifies complex queries that should be supported by RecordInstanceDataPageQuery.
• You can specify attribute Id in place of attribute name.
• You can specify the existing way of adding qualifications.
• Ensure that you follow the URL encoding rules while specifying queryExpression.

For example:

• To specify complex query supported by RecordInstanceDataPageQuery.
  &queryExpression=('Description' LIKE "%A%" AND 'TaskID' > 29 )&startIndex=0&pageSize=-1
• To specify atrribute Id for Description and TaskID attribute name.
  &queryExpression=('536870913' LIKE "%A%" AND '536870915' > 29 )&startIndex=0&pageSize=-1
• To specify the URL encoding rules.
  &queryExpression=('Character Field1' = %27Character Field1%27%3D%22some description%22), where %27 represents ', %3D represents =.