Class DataRequestBuilder.DataRequestBuilderGetQueryParameters

Deprecated in favor of records endpoints. We have no immediate plans to remove these endpoints, but consider records a better starting point for new projects.

Inheritance
object
DataRequestBuilder.DataRequestBuilderGetQueryParameters
Inherited Members
Namespace: Grist4NET.Kiota.Docs.Item.Tables.Item.Data
Assembly: Grist4NET.Kiota.dll
Syntax
public class DataRequestBuilder.DataRequestBuilderGetQueryParameters

Properties

CellFormat

With "typed", every cell value is returned in a self-describing typed form, e.g. a Date as ["d", timestamp] and a Reference as ["R", tableId, rowId], and formula errors are returned inline as ["E", ...] values. The default "normal" format uses compact values whose interpretation depends on the column type. See Grist data format for details.

Declaration
[QueryParameter("cellFormat")]
public GetCellFormatQueryParameterType? CellFormat { get; set; }
Property Value
Type Description
GetCellFormatQueryParameterType?

Filter

This is a JSON object mapping column names to arrays of allowed values. For example, to filter column pet for values cat and dog, the filter would be {"pet": ["cat", "dog"]}. JSON contains characters that are not safe to place in a URL, so it is important to url-encode them. For this example, the url-encoding is %7B%22pet%22%3A%20%5B%22cat%22%2C%20%22dog%22%5D%7D. See https://rosettacode.org/wiki/URL_encoding for how to url-encode a string, or https://www.urlencoder.org/ to try some examples. Multiple columns can be filtered. For example the filter for pet being either cat or dog, AND size being either tiny or outrageously small, would be {"pet": ["cat", "dog"], "size": ["tiny", "outrageously small"]}.

Declaration
[QueryParameter("filter")]
public string Filter { get; set; }
Property Value
Type Description
string

Limit

Return at most this number of rows. A value of 0 is equivalent to having no limit.

Declaration
[QueryParameter("limit")]
public double? Limit { get; set; }
Property Value
Type Description
double?

Sort

Order in which to return results. If a single column name is given (e.g. pet), results are placed in ascending order of values in that column. To get results in an order that was previously prepared manually in Grist, use the special manualSort column name. Multiple columns can be specified, separated by commas (e.g. pet,age). For descending order, prefix a column name with a - character (e.g. pet,-age). To include additional sorting options append them after a colon (e.g. pet,-age:naturalSort;emptyLast,owner). Available options are: orderByChoice, naturalSort, emptyLast. Without the sort parameter, the order of results is unspecified.

Declaration
[QueryParameter("sort")]
public string Sort { get; set; }
Property Value
Type Description
string