Configure API output parameters - Precisely Data Integrity Suite

Select which response parameters from the API will be available in your pipeline. You can map API response fields to new or existing pipeline fields.

1. Navigate to the output configuration section for your API endpoint.
2. Review the list of available response parameters. Each parameter shows:
   1. Select properties: Checkbox to include the parameter
   2. Type: The data type of the response parameter
   3. New/Existing Field Name: Where you specify the field name in your pipeline
3. Select the response parameters you want to include in your pipeline by checking the checkbox next to each parameter.
4. For each selected parameter, specify the field name:
   1. To create a new field: The default field name is automatically populated from the API response parameter name. You can change this to a more meaningful name.
   2. To overwrite an existing field: Select an existing pipeline field from the drop-down instead of using a new field name.
5. For array parameters in the response, configure multiple output fields as needed. Array objects in 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.
   1. Select the array parameter to include it in the output.
   2. The first set of array fields is created with the default name.
   3. To add additional sets, click Add Array Set.
   4. 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 needed.
6. If you want to overwrite an existing pipeline field with API response data, select that field from the dropdown.
7. Verify that all field names are unique. If you manually enter a name that already exists in the pipeline, you will be prompted to change it.
   Note: Both the new field and the existing field with the same name will be highlighted to help you identify the conflict.
8. Click Save to save your output configuration.