Hosting databases for OData access

Open Data Protocol (OData) is an industry-standard API implementation that provides a standard method for querying and updating data, allowing REST API clients to access FileMaker data hosted by FileMaker Cloud and FileMaker Server. OData conforms to Representational State Transfer (REST) architecture and is therefore a REST API.

To host a database for access via the OData API:

1. In FileMaker Pro, open the database and edit the privilege set for the account that will access the database. Enable the extended privilege Access via OData (fmodata).

   Note  If your FileMaker Pro database solution uses more than one FileMaker Pro database file, all of the database files accessed using the OData API must have the extended privilege Access via OData (fmodata) enabled.

2. In Admin Console, use the Connectors > OData tab to enable OData API. See OData API settings.

3. Prepare databases for access via the OData API. See FileMaker OData Guide.

4. Upload the database file to FileMaker Server. See Uploading database files using FileMaker Pro.

   Note  If your FileMaker Pro database solution uses more than one FileMaker Pro database file, all of the database files accessed using the OData API must be on the same computer.

5. Use a REST-compliant web service to send HTTPS requests in the form of URLs that specify the OData API statements.

   For information on writing web services that use the OData API, see FileMaker OData Guide.