This topic explains how to access and use service endpoints in the Data Quality application, including selecting pipelines, submitting data that matches the required schema, and interpreting responses. It also outlines typical use cases and best practices for integrating and testing services within your applications.
Accessing a Service
To access a service endpoint:
-
Select a deployed pipeline from the list.
-
Go to the Services tab. You will see a table with the following details:
-
Service Name: Automatically generated from the pipeline name (for example, Pipeline_e2e_us_address_data_2).
-
HTTP Method: Usually POST, indicating the API accepts data in the request body.
-
Endpoint URL: The REST URL to submit data (for example, /v1/api/service/{serviceName}/runconf).
-
-
To test the service, click Try it out on the page.
Submitting Data - Request Body
Each service requires a request body that matches the input schema of the pipeline’s first step. The interface displays all required fields, example values, and expected data types.
Example Input:
{
"e2e_us_address_data": [
{
"AddressLine2": "string",
"AddressLine1": "string",
"FirmName": "string",
"StateProvince": "string",
"InputValue": "string",
"Postcode": "string",
"City": "string"
}
]
}
- Field names must match those defined in the pipeline’s input step.
- You can submit multiple records in a single request.
- All values should be sent as strings unless otherwise specified in the pipeline schema.
Understanding Responses
The Responses section provides:
-
Any error codes that may occur if validation fails or required fields are missing.
-
The output schema, which is based on the final step of the pipeline.
Typical Use Cases
Service endpoints are ideal when you need to:
-
Validate or standardize addresses from an external application.
-
Automate workflows that use pipeline logic.
-
Integrate Data Quality functions into portals, CRMs, customer onboarding systems, or ETL tools.
-
Batch-process multiple records via API instead of manual file uploads.
Best Practices
-
Always review the input and output schemas before integrating the service into your application.
-
Use the Try it out feature to test your data and understand the expected responses.
-
Handle error codes in your application to ensure robust integration.