An API's route is the part of the API's URL that instructs fSeries as to how which API to return and the parameters to use. The full URL consists of the following elements:

• fSeries API Server (see Account API Server)
• Api
• Version (if Account API Version Prefix is set)
• API Route (set here)
• Querystring parameters (e.g. ?key1=value1&key2=value2)

NOTE: A route may only be added for published APIs and an API is not available to external systems unless a route has been added. Only data and documents set up in this way are available to external systems.

If Account API Version Prefix is set, enter the Version of this API (or leave blank for '1.0'). This will be required before the route information itself (e.g. https://www.myapi.com/API/1.0/…)

The route may either be entered directly (e.g. SV/Data/{UPN}) or created using the Route Elements Builder.

The route consists of a set of elements separated by / each either refines the area of the API or specifies a poarameter value. In this case the API is part of the SV group of APIs further refined as returning Data, being passed the UPN as a parameter.

When using the Route Elements Builder, enter each element in the list and use the icons to the left and right to re-order or remove elements respectively. Click Add Element to add another element to the list.

On the right hand side of the page a list of all external inputs required by the API's underlying entity is displayed. If not already part of the route, click to add to the end of the route. Any not added in the route may be provided as part of the querystring parameter list.

If you have previously set up routes an option will let you see all routes previously set up and click on one to use as a start point. You cannot use the same route twice but this option makes it easier to ensure that your RESTful paths are consistent.

You can run a test of your route by clicking the Test button at the top of the screen and entering the requires details, including an API User on whose account you are testing.