The LiveLink (OData) page (Administration > Interfaces > LiveLink (OData)) provides a developer tool you can use to exchange data with the VertiGIS FM database using Open Data Protocol (OData) .

Currently, the tool has over 30 endpoints available. Developers in your organization can use them to read data from the VertiGIS FM database or to write data into it.

LiveLink (OData) Page in VertiGIS FM

Activating the Service

By default, the OData service is deactivated when you install VertiGIS FM. To active the service, double-click it on the Administration > Interfaces > API page.

OData Service in VertiGIS FM Administration

To activate the service, select the Active check box and click Save.

Activating OData

When the service is activate, the exposed endpoints appear in the Endpoints section.

Endpoints Section

To deactivate the service, deselect the Active check box and click Save.

Using the Service

Double-click an endpoint to see a description of the API.

Endpoint Link

Interface Description

Example Client

You can click the link in the OData example-client section to download a .zip folder.

OData Example Download Link

The contents of the file includes examples of how to execute data exchanges with the API.

ODataClients.zip Contents