Query Parameters

FILTER

Filter string which should general include a table name. For example: Filter=WKREQ WHERE RQ_STAT_CD < 950 (provided un-encoded here for clarity)

FILTERID

Filter Id that should be used to filter the data. Each module has a list of canned or predefined filters that have been saved by users. This is the AutoNumber that represents that saved filter. These filters are available as a list that you can show users (See Special Functions).

ORDERBY

The property or field name that the data should be sorted by. This is the Autonumber property by default (descending order). For example: OrderBy=StatusCode+DESC

TAKE

Designates how many records should be returned. By default 10 will be returned. The max is limited based on the Lucity Administrator assigned max in Lucity System Settings (max is defaulted to 50).

SKIP

Designates how many records to skip. For example, to get the second set of 15 records, the Skip = 15 and the Take = 15. Skip MUST be divisible by Take. You cannot request Skip = 20 and Take = 15. This will result in a 400 Bad Request error.

FORMAT

format=json or format=xml. The default is xml.

EMAIL

The email address of the requestor. This only is available for the public REST API and is affected by a system setting.

REQUESTNUMBER

The request number. This is only available for the public REST API and is affected by a custom setting

STARTSWITH

Limits returned records to only records that start with the provided text. Only supported on limited endpoints (picklists mostly)

NULLWRITES

Used only on PUT requests. Controls how null values (or missing properties) are handled. By default missing properties or null values (or default values such as 0 for a non-nullable numeric) are ignored in the input. To override this behavior and force these null values to be set, pass NULLWRITES=TRUE. This means that if a property is missing or has a null value, the REST API will attempt to change that value to null on the server (if the property is writable). Do not use this option unless you are certain you will be sending up every property on PUT requests or you may end up overwriting real data.

311ONLY

This parameter is used on problem picklists only and tells the application to only return problems that are marked for 311 in the problem setup module.

PROPERTYID

Used for limit lists for picklists. This property id is the id of the field on a submit form where a user has defined a limit list.

IDLIST

Filters the data to only items where the AutoNumber or unique Id are in the list provided. This is not a text field, it corresponds to the identity column in the dataset. This property in the response objects is always "Autonumber". Used only on GET requests.

SELECTEDIDS

Used for tools to indicate which ids the tool should be applied to.

PROPERTY

Used on POST and PUT $nonpersistent requests only. Used to indicate the last field the user edited and is helpful for the server in figuring out what the object should look like after the user’s edits.

DOCDESCRIPTION

Query parameter used when uploading new documents. Allows for a description to be set on the document. By default the document description is the date and time of the upload.

WARN

Indicates that the code should provide warnings (these will be returned as 409 CONFLICT responses). By default warnings are ignored in the REST API and will not be returned for display to the user.

STARTSWITH

This is a special query parameter only available for certain lookup lists such as category, problem, or standard code type values. For example: STARTSWITH=a will return all code types where the code (and in some cases the type) starts with an a.

COMMONID

Allows for a query based on the common id of an asset. This is only supported in limited inventory and inspection modules. This corresponds to a text value which should be encoded in the request if there is any risk of spaces or special non alphanumeric characters may be used.

INVALIDSTREETTOGENLOC

This setting is used for the Public REST API. If there is a problem with the street name the user provided, that the value should be placed in the non-validated general location field. By default this is false.

STATUSFLAG

Supported for request and work order modules only. Allowed values are CLOSED and OPEN

STATUSDAYS

Works with the STATUSFLAG query parameter. Limits the data returned to only records whose status has changed in the last X days. By default the STATUSFLAG query parameter returns all records (up to the maximum take).

COORDSYS

This is a special query parameter only used with the Citizen Portal REST API. See documentation on configuration for a discussion on this parameter. Available options are COORDSYS=LOCAL, COORDSYS=MERCATOR, COORDSYS=LATLONG