Configuring an ION API data service

Whether creating a data service in a project or in the App Builder Repository, you can use an API Gateway or ION API as the source. This sub-procedure describes how to configure that data service.

To configure a data service using an API Gateway or ION API as the source, use this sub-procedure:

Note: This sub-procedure assumes you have already performed the actions in either the topic Creating a data service within a project or the topic Creating a data service in the Repository).
  1. In the Create Data Service - Find API dialog box, use the Suite drop-down menu to select the Infor product suite that contains the API you want.
  2. Optionally, to filter your search for the desired API, specify a search term in the Search field, and then click Search.
  3. Optionally, to filter the results according to specific operations, select the operations to search for, using the list of If you leave this field blank, App Builder searches for all available APIs in the suite (or all suites, if no suite has been specified). Filters.
  4. From the list of results, select the API you want.
    Note: If you are using the Infor Mongoose REST API set, you must select only APIs that use JSON.

    To view the details for a particular API, what properties it contains, and so on, click Details for that API. This launches the Operation details dialog box, which displays detailed information about the API.

  5. Once you locate and select the API you want, click Next.
    App Builder opens the Create Data Service dialog box to the Input Parameters page. This page displays information about any input parameters required by or accepted by the API. You can also use this page to modify input parameters for the API.
    View JSON
    Http Method
    From the drop-down list, select the type of HTTP action to take with the API request.
    API Relative URL
    This field displays the URL for the API, relative to
    Request Header
    This field displays the request header information for the API request.
    Input Parameters
    This section displays options to set input parameters for the API request. You can add or remove parameters, set parameters as requred, define the parameter types, and optionally provide aliases for the parameters.
  6. Optionally, verify that the data service is performing as desired:
    1. Click Test Data Service.
    2. In the Test Data Service dialog box, manually input values for any required input parameters.
    3. Optionally, manually input values for any optional input parameters you want to test.
    4. Scroll to the bottom of the dialog box and click Run Data Service.
    5. Verify that the data service response is as expected by examining the contents of the Response Body field.
    6. Assuming the data service responds as expected, optionally click Copy to clipboard.

      This copies the entire contents of the Response Body field to the system clipboard. You will need this data to test the output parameters.

    7. Click Close.
  7. When you are finished with the Input Parameters page, click Next.
    App Builder opens the Output Parameters page. Use this page to specify this information:
    Output Type
    Select the response output type.
    • JSON requires the response data to be in JSON format.

      In the next step, you can use the data copied in the previous step to provide this.

    • File requires the data to be imported from a file, as specified in the Response alias field.
    Root Element
    Object Id
    Output Parameters
    Use this section to generate and test output parameters for the selected API.
    GENERATE PARAMETERS
  8. Optionally, test the data service to verify that it accomplishes whatever it is supposed to. To do this, click Test Data Service, provide whatever input parameters are needed, scroll to the bottom, and click Run Data Service.
    The results of the test display in the Response Body section of the Test Data Service dialog box. If the expected data is returned, then the test was successful.
  9. Click Next.
  10. On the Name & Description page of Create Data Service, provide a Name and optional Description for the data service.
  11. Click Next.
  12. On the Summary page of the wizard, verify that all your specifications are correct. When you are satisfied that they are, click Finish.
    App Builder adds the data service to the list of available data services.
  13. Click Close.
The new data service is now available for use in the App Builder workspace.
Related topics