Rest API

The REST API tab allows administrators to set up the Lucity REST Public and Internal Webservices API.

To make changes to the REST API settings, click in one of the Value fields and begin typing. Click Save when finished.

Field

Function

Allow RequestNumber and Email queries to the Citizen Portal REST API without providing both parameters

Controls how the Citizen Portal REST API works. Enable this option to allow the API to search for a Request using either the Request Number or Email address without having to have both parameters.

Block SQL for the Lucity Citizen Portal REST API

When activated, reduces the risk of SQL Injection attacks from the Citizen Portal site by preventing third-party applications that use the Lucity Citizen Portal REST API from providing direct SQL for querying records. Before setting this option to true, make sure third-party applications do not require querying capabilities.

Block SQL for the Lucity REST API

When activated, reduces the risk of SQL Injection attacks through the REST API by preventing third-party applications that use the Lucity REST API from providing direct SQL for querying records. Before setting this option to true, make sure third-party applications do not require querying capabilities.

Default Public REST WKID

Specifies the WKID (well-known ID) for the coordinate system used by the external GIS service, if:

and

  • the external services is NOT using a Mercator projection.

Disable DOS protection

Turns off protection against denial-of-service attacks.

Logon to use for anonymous REST API Access

Allows anonymous users to gain access to Lucity.

Maximum records to return

Limits the amount of records in a filtered set. The higher the number, the more likely it is that web server performance will be affected.

Use an alternate coord system as the Default Coordinate System for Public REST calls

If this option is false, the system assumes that any incoming geographic information is using the Operational Data Spatial Reference WKID found on the GIS Web tab.

If this option is set to true and the Default Public REST WKID is blank, the system assumes the incoming geographic information is using a Mercator projection. If the Default Public REST WKID is filled out, the system uses the specified WKID's projection.

Use Extensionless URL's (only supported in IIS7+)

Allows administrators to choose to omit the extension in the REST API URLs.

  • For example, if the URL is http://restapi.gbams.net/Public/Work/Requests.svc/57481, setting this option to "True" would allow users to use the following URL instead: http://restapi.gbams.net/Public/Work/Requests/57481. Note that the second URL does not include the ".svc" extension.

See Also

Settings

Appearance

Designer Automation

Documents

Email

General

GIS 3rd Party Integrations

GIS Desktop

GIS Edit Integration

GIS Routing

GIS Web

Mobile

SaaS

Settings with Custom Interface

Timesheet

Web Performance

Website

Work

Work Zones