Creating an IDO from an ION API

You can create a Mongoose IDO that uses an ION API to access a source of data. Use the IDO from ION API Wizard to connect with an ION API, using its swagger documentation to define parameters and generate an IDO, complete with table and properties.
  1. Open the IDO from ION API Wizard form:
    Note: 
    • Before using this wizard, you must have an ION API server set up for it, using the ION API Servers form.
    • You must be authorized to use Runtime Builder forms to access and use this form.
    1. Launch the Runtime Builder Selection dialog box.
    2. From the Category drop-down list, select External Data Source (ExtDatasource).
    3. From the Runtime Builder drop-down list, select IDO from ION API Wizard (IDOFromIONAPIWizard).
    4. Click OK.
  2. In the IDO from ION API Wizard form, make these settings:
    Server ID
    From the drop-down list, select the server you want to use to connect with the ION API.
    Suite Context
    From the drop-down list, select the ION API suite that contains the API you want.
    Proxy Path
    If the API contains multiple endpoints, specify the proxy path to be used to locate the swagger documentation.
    Note: You can obtain the proxy path from the ION API endpoint itself, using the ION API app. For instructions on how to do that, consult the ION API app documentation.
    Select Method to Generate IDO
    From the drop-down list, select the method to create when generating the IDO. When applicable, this is the method that handles and processes the posting of data from the ION API.
  3. Click Next.
    The wizard proceeds to the Get Input Parameters page, which displays the input parameters for the specified endpoint.
  4. At a minimum, provide values for any required parameters.
    Note: Information about parameters, whether they are required or not, are derived from the swagger documentation provided for the API in the ION API app. You should be aware that, depending on the endpoint you are using, some parameters required by the API might not indicate as required by the endpoint; but they are still required for use by the IDO that is generated.
    Values for other parameters are optional, depending on what data you want and how you want to use them. Any values you provide are used to filter the data that is retrieved by the IDO.
  5. Click Next.
    The wizard proceeds to the Get Output Parameters page, which displays the list of properties to be created as IDO properties that you selected.
  6. Select the parameters you want to use as output parameters.
    Typically, this is only the parameters required by the endpoint.
  7. Click Next.
  8. On the Add Post Method and Parameters page, at a minimum, provide values for any parameters required for Post (Add) operations.
    Note: 
    • If a parameter is of the Type "body", then you must obtain the JSON-formatted body template from the API endpoint, modify it, and paste it into the Value field.

      See Getting body parameter formats for ION API-based IDOs.

    • If a selected parameter is required, the Value column cells all turn yellow (not just the cells for the required parameters), indicating that a value is required for the selected parameters. For parameters that are not required, the cells all turn white (including the cells for the required parameters). For this reason, you should make sure you know ahead of time which parameters are required by the API and which are not.

    Values for other parameters are optional, depending on your needs.

  9. Click Next.
  10. On the Add Put Method and Parameters page, at a minimum, provide values for any parameters required for Put (Update) operations.
    Note: See the notes for Step 8.
  11. Click Next.
  12. On the Add Delete Method and Parameters page, at a minimum, provide values for any parameters required for Delete operations.
    Note: See the notes for Step 8.
  13. Click Next.
  14. On the Generate IDO (final) page of the wizard, supply this information:
    IDO Name
    Provide the name to assign to the newly generated IDO in Mongoose
    Project Name
    From the drop-down list, select the IDO project to which the generated IDO is to belong.
    Description
    Optionally, provide a description for internal use that can be used to identify the purpose and/or intendeed use of the new IDO.
  15. Click Finish.
    The wizard proceeds to generate the IDO, creating the appropriate properties and tables, and then to check in the newly generated IDO. If successful, the system displays a message to let you know that the IDO was generated successfully.
  16. (Optional, but recommended) Use the IDOs form and related IDO forms to verify that the IDO exists and has the correct properties and methods.
The IDO can now be used much like any other IDO collection in your application.
Caution: 
When using this IDO collection in a form, you must use the GetIONAPIData custom load method with it. Otherwise, your application cannot find and retrieve the requested data.

To do this, in Design Mode or the Web Designer, select the Collections property sheet, and then select GetIONAPIData as the Custom Load Method attribute value.

Depending on the API endpoint you are using, you might also need to provide load/save override methods.

Related topics