Make API Call - Precisely Data Integrity Suite

The Make API Call step enables you to integrate external APIs into your data pipelines. You can configure API sources, define endpoints, and map input and output parameters to create seamless data exchanges with external systems.

1. In a pipeline, locate where you want to add the API call and click the + symbol.
2. In the Add Step dialog box, click General, then click Make API Call.
3. In the Make API Call panel, on the Properties tab click the Select API box.
4. In the API Sources panel, expand either Precisely APIs or Other APIs, and click an API to choose it.

   Option	Description
   Precisely APIs	Lists APIs for Precisely applications
   Other APIs	Lists APIs for external applications. These are defined using OpenAPI specs.

   API sources are managed in the Configuration settings for a workspace, but you can also add them here if you have permission to manage APIs. To do so, click the Add button to create an API source and start with step ../../configuration/apis/apis-add-source.html#task_sgj_ltm_fjc__general-steps-start in ../../configuration/apis/apis-add-source.html.
5. On the API Source panel, click to select an endpoint method, then click Select.
   Endpoints for an API source are managed in the Configuration settings for a workspace, but you can also add them here if you have permission to manage APIs. To do so, click the Add Endpoint button and start with step ../../configuration/apis/apis-add-endpoints.html#task_edit-endpoints__start-general-steps in ../../configuration/apis/apis-add-endpoints.html.
   On the Make API Call panel, the selected API now shows in the Select API box, and the default base URL for the endpoint shows in the Base URL box.
6. Optional: If a different base URL is required for this pipeline, for Base URL choose a different base URL.
7. Configure request parameters for the API call.
   Input parameters specify which data the pipeline sends to the API server. You can provide static values or map fields from your pipeline data to API parameters. The available input fields depend on which parameters were exposed when you configured the API endpoint.
   1. In the Input panel, click Configure.
   2. Review parameters to be configured.
      Each parameter in Request Parameters shows:
      • The name of the parameter.
      • Type—The data type of the parameter.
      • Enter Value or Map Field—Configurable input fields or options.
   3. Depending on a field and its data type, perform the appropriate action.

      To	Do this
      Enter a literal numeric or text value (Enter Value)	Enter the value in the input field.
      Enter a boolean value (Enter Value)	Choose True or False.
      Map a pipeline field (Select Field)	In the drop-down box, select a pipeline data field.
      For an array [ ] parameter	Click the + to configure as many rows or row-sets as required. Configure each row with the appropriate value or field mapping. Click - to remove a row or row-set.

      Note: Required parameters are marked with an asterisk (*). Depending on the pipeline, you may choose to specify a value for an optional parameter.
   4. Click Apply.
      A green check box is displayed in the Input panel if all required fields are configured. The number of mapped fields is also shown on the panel.
   When the pipeline calls the endpoint method, it will submit specified values and mapped field values to the API server.
8. Configure response fields for the API call.
   The output configuration specifies which fields from the API response will be available in your pipeline. You can create new fields or overwrite existing pipeline fields with the API response data. The available response fields depend on which parameters were exposed when you configured the API endpoint method.
   1. In the Output panel, click Configure.
   2. Review response fields to be configured.
      Each field in Response Fields shows:
      • The name of the field.
      • Type—The data type of the field.

      • New/Existing Field Name—Select an existing field or enter the name of a new field to be populated by the response.

   3. Select the checkbox next to response fields that you want to include in the pipeline.
   4. For each selected field specify the field name that will be populated in the pipeline.

      To	Do this
      Create a new field	The default field name for New/Existing Field Name is the same as the API response field name. You can change this to a more meaningful name.
      Overwrite an existing field	Select an existing field name in the New/Existing Field Name drop-down list.

   5. For object fields in the response, expand the object and select each field in the object as required.
      You can select or clear the checkbox next to the object name to select or clear all fields in the object.
   6. For array fields [ ] in the response, configure multiple output fields as required.
      Array fields in a JSON responses can be added multiple times. For example, if your API returns multiple address sets, you can configure separate output fields for each address set.
      • Select the array field to include it in the output.
      • The first set of array fields is created with the default name.
      • To add additional sets, click Add Array Set.
      • For subsequent sets, the field names are automatically appended with a count number (for example, address_2, address_3) to avoid duplicate names. You can change these names as required.
   7. Verify that all field names are unique.
      You will be warned with a red error (!) message tags an output field when the field name already exists in the output configuration. You cannot apply changes when any output field is tagged by error messages.
      A blue information (i) message tags an output field if it will overwrite an existing pipeline field. You can ignore an information message if it describes your intent.
   8. Click Apply to save the output configuration.
      The API response data will be available in your pipeline using the specified field names.