Creating a data service from API Gateway

  1. On the Data Services page, click New.
  2. In the Create from Wizard dialog box, select API Gateway.
  3. Click Create.
  4. In the Create Data Service - Find API dialog box, specify this information:
    Search
    Optionally, specify a word related to the API.
    Suite
    Optionally, select an application suite.
    Methods
    Select the applicable HTTP methods.
  5. Click Search.
  6. From the search results, find the API and click Select.
    To view the API’s input and output parameters, click Details.
  7. Optionally, in the Create Data Service > Name & Description section, modify the data service name, description, and assign tags.
  8. Click Next.
  9. Optionally, in the Create Data Service > Input section, perform these steps:
    1. In the Response Information section, specify this information:
      HTTP Method
      Select the type of HTTP action to take with the API request.
      API Relative URL

      This field displays the relative URL for the API.

      Click the Edit icon to change the relative URL.

      Note: If you change the relative URL, the input parameters changes as well.
      Request Header
      This field displays the request header information for the API request.

      Click the Edit icon to add or remove header parameters.

      View/Edit JSON
      Click this icon to view and edit the JSON code schema and template.
      Note: This button is enabled for PUT and POST APIs only. This button requires a JSON body.
    2. In the Input Parameters section, select Add Parameter.
    3. Specify this information:
      Required
      Click this check box to set a parameter as required.
      Alias
      Optionally, specify a name to replace the original parameter name.
      Default
      Optionally, specify the value to filter data service on first load.
      Note: The default value is used when a value is null or undefined. If a real value is present, the default value is ignored.
    4. To view information about JSONPath, click JSON Help.
    5. To delete a parameter, click theDelete icon.
  10. Optionally, test the data service:
    Note: The selected data service runs in the target system.
    1. Click Test Data Service.
    2. In the Test Data Service dialog box, specify values for the input parameters.
    3. Click Run Data Service.
    4. In the Response Body field, verify if the content is correct.
    5. Click OK.
  11. Click Next.
  12. Optionally, in the Create Data Service > Output section, perform these steps:
    1. In the Response Information section, select the response output type.
      • JSON: This option requires the response data to be in JSON format.
      • File: This option requires the response data to be imported from a file, as specified in the Response alias field.
    2. If you select File, specify the response alias.
    3. If you select JSON, specify this information:
      View/Edit JSON
      Click this icon to view and edit the JSON code schema and template.
      Note: This button is enabled for PUT and POST APIs only. This button requires a JSON body.
      Root Element
      Specify the JSON root element.
      Object ID
      Specify a unique key. This key is used for selecting items on refresh.
    4. In the Output Parameters section, select Add Parameter.
    5. Specify this information:
      Name
      Specify the name of the JSON output.
      Alias
      Specify a name to replace the original parameter name.
      Data Type
      Select the data format to be returned by the data service.
    6. To generate empty output parameters, click Generate Parameters.
    7. To view information about JSONPath, click JSON Help.
    8. Optionally, test the data service.
  13. Click Next.
  14. In the Create Data Service > Summary section, review the data service information.
  15. Click Finish.
On the Data Services page, the new data service is automatically added to the list.