Managing REST API Requests and Responses Using REST Clients

REST clients are methods or tools to invoke a RESTful web services and test the APIs and capture HTTP requests and responses.

Example: GET Request

This example provides detailed instructions on how to retrieve a resource record from an Oracle Utilities application using any REST client.

To retrieve a resource:

  1. Provide the HTTP method and the request URL to the REST client. This example uses a GET method. For information on constructing the request URL, see Establishing a Connection. An example for a Cloud request URL is as follows: https://{host}/{tenant}/dev01/{appName}/rest/apis/{owner}/{resourceCategory}/{resource}/{iwsOperationPathParameter}
  2. For the authorization parameter, and provide the user name and password.
  3. For the header, define the following key and value pairs:
    • Accept: application/json

    • Content-Type: application/json

    This example sends and accepts JSON. To send and accept XML, change both values to application/xml.
  4. Issue the request, which will return an applicable response.