Creating a data service from an ION API

  1. On the Data Services page, click the New Data Service icon.
  2. In the Create from Wizard dialog box, select ION API.
  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 Basic Request 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 JSON
      Click this icon to view the JSON code schema and template.
    2. In the Input Parameters section, specify this information:
      Add Parameter
      Select the parameters to add to the API request.
      You can add or remove parameters, set parameters as required, define the parameter types, and optionally provide aliases and default values for the parameters.
      Note: The default value is used when a value is null or undefined. If a real value is present, the default value is ignored.
      JSON Help
      Click this icon to view information about JSONPath.
  10. Optionally, test the data service:
    Note: The selected data service will run 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 Basic Request Information section, specify this information:
      Output Type
      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.
      VIEW JSON
      Click this icon to view the JSON code schema and template.
      Root Element
      Specify the JSON root element.
      Object ID
      Specify a unique key. This key is used for selecting items on refresh.
    2. In the Output Parameters section, specify this information:
      Add Parameter
      Click this icon to add a parameter and its alias.
      JSON Help
      Click this icon to view information about JSONPath.
      Generate Parameters
      Click this icon to generate output parameters.
  13. Optionally, test the data service:
    Note: The selected data service will run in the target system.
    1. Click Test Data Service.
    2. In the Test Data Service dialog box, specify values for the output parameters.
    3. Click Run Data Service.
    4. In the Response Body field, verify if the content is correct.
    5. Click OK.
  14. Click Next.
  15. In the Create Data Service > Summary section, review the data service information.
  16. Click Finish.
On the Data Services page, the new data service is automatically added to the list.