1. REST API for Oracle Utilities Work and Asset ManagementOracle Utilities REST API for Work and Asset
  2. Testing the REST APIs
  3. Using TryItOut in Oracle Utilites Application

Using TryItOut in Oracle Utilites Application

The quickest and easiest way to test REST APIs is within a given environment because the connection details are automatically enabled and the client is provided from within the application itself.

  1. From your Oracle Utilities application, navigate to the Admin - Inbound Web Services to view the details of the API. The documentation for the REST services within the product are available in OpenAPI format to allow integration and REST clients developers to understand the structure of the API.
  2. Click the View Specification link for the Inbound Web Service to view the REST API specification specific to the base server URL, with all the URIs defined in the service and the model schema for each of the service request and response structures. The instance values are provided to save time in testing and integration from other clients.
  3. Click the Download button to download documentation in JSON format, which can be loaded into an OpenAPI compatible development tool.
  4. To invoke the service, click the Authorize button and provide the required user credentials.
  5. For each operation, it is possible to select the TryItOut button to test the API by entering valid input parameter values and selecting Execute to see sample results within the documentation.

Note:

Only Inbound Web Services that are Active can be tested with the TryItOut function. There are a number of REST APIs provided with Integration Suite add-on options for the Oracle Utilities applications. The REST APIs included with this add-on are delivered Inactive by default and are also identified by an Inbound Web Service Category of F1-INTG-SUITE to make it clear that these need to be activated for use and only allowed with the appropriate Integration Suite options for the Oracle Utilities Application.

The Operation on the REST Inbound Web Service references a Service Script that requires an Application Service for security purposes. An administrator must grant security access to that application service to the user submitting the REST service. The APIs that are part of the Integration Suite are delivered with the Application Service of F1-INTG-SUITE-API.