AX1808

Enabling the OData API

The OData API is disabled by default. If you want to use it, you must enable the system configuration setting EnableODataAPI and then reset your application server.

You can modify the system configuration setting using either the Axiom Software Manager or a Save Type 4 report. The instructions in this topic assume you are using a Save Type 4 report.

NOTE: The tasks to enable the OData API require administrator permissions to Axiom Software.

To enable the OData API:

  1. In the Desktop ClientGeneral term for using either the Excel Client or the Windows Client, both of which are installed to the user's desktop., open the following system configuration template from Axiom Explorer or the Explorer task pane: \Axiom\Axiom System\Document Templates\Support Utilities\SystemConfigurationTemplate.xlsx

    Alternatively, if you already have a custom-built Save Type 4 report to Axiom.SystemConfiguration, you can use that report.

  2. On the Axiom tab, in the File Options group, click Refresh to bring in the most current list of system configuration settings.

    In systems with installed products, this feature may be located on the Main tab.

  3. Locate the row for EnableODataAPI, and type True into the Modify column (H).

  4. On the Axiom tab, in the File Options group, click the down arrow to the right of the Save button, and select Save Data Only. You can also click Save directly, but in that case you will see an error about being unable to save changes to the file. However, the data will still be saved and you can safely ignore this error.

    In systems with installed products, you may only have access to the Save button and it may be located on the Main tab.

    The OData API is now enabled in the system. In order for the change to take effect, you must reset your application server.

  5. In the Web Client, click the menu icon in the Global Navigation BarThe blue bar across the top of pages in the Web Client. The Global Navigation Bar provides access to system-wide features.. From the Area menu, select System Administration.

  6. In the System Administration area, from the Navigation panel, select Infrastructure Section > Reset Services.

  7. In the Current Server Status section, locate your application server and then click Reset. The application server is identified by the server name and the service type (Application Server).

Once the application server has restarted, the OData API will be available for use.

See also