Exploring the FME REST API Homepage

The FME Server REST API Homepage is an essential tool for any FME Server API user. It is also an example of a well documented API that provides clear examples of the requests and methods supported along side with the authentication process. It is a good starting point to understand how APIs are put together and how the response and methods can be constructed.

The API homepage provides the documentation needed to learn about the FME Server REST API. It also allows the user to view all calls available on the REST API. Each call has detailed documentation about the call and any parameters connected to the call. It also allows the user to practices a call before implementing it.

Now that you know the basic information on using the REST API, we can explore how to use it. The first step is to visit your homepage for the REST API. To find this, go to

http://<yourServerHost>/fmerest/

Or the current version is maintained online and is available here Online API Documentation

You may also access this same page through your FME Server. Simply, go to your FME Server homepage, locate the help button and click on the REST API button. This page provides helpful resources when first learning the REST API. This includes sample calls you can make to FME Server. On the main toolbar click on the API Link.

Here, you can explore the various calls you can make to FME Server. Find the third category called health check and expand the call. You should see documentation similar to this.