Retrieving Data Quality Rules Using REST API

Transcription

1 Retrieving Data Quality Rules Using REST API Copyright Informatica LLC Informatica, the Informatica logo, and Informatica Cloud are trademarks or registered trademarks of Informatica LLC in the United States and many jurisdictions throughout the world. A current list of Informatica trademarks is available on the web at

2 Abstract Informatica provides a REST API that you can configure to retrieve data quality rules from Axon. This document describes the parameters for the REST API. Table of Contents Overview... 2 Prerequisites... 3 Configuration... 3 Example... 4 Overview Informatica provides a REST API that allows you to retrieve data quality rules from Axon. Use this REST API if you do not have Informatica Data Quality. If you use another data quality application, use this API to fetch data quality rules from Axon. You can access the REST API at the following location: 2

3 Prerequisites Before you send the payload request, you must authenticate yourself with your user name and password. Enter the following parameters to receive a JW token: API: Method: POST Input parameters: <user_name> and <password> After you enter these parameters, you will receive a JW token as the Output parameter: Output: <your_jw_token> Send the API payload request and the JW token to retrieve the data quality rules from Axon. Configuration The following table lists the configurations of the REST API: URL Method Parameter to set the number of rules that are retrieved Parameter to set pagination for the list of rules that are displayed api/v1/dqrules GET limit=<integer> This parameter is optional. If you do not enter the parameter, all rules are retrieved. offset=<integer> Success response Code: 200 Error response This parameter is optional. If you do not enter the parameter, 0 is set as the default offset value, and all rules are displayed on screen. Code: 401 UNAUTHORIZED Content: { error "Log in" } OR Code: 500 Internal Server Error Content: { error : "Unable to fetch the dq rules" } 3

4 Example You want to send the Axon data quality rules to your data quality program. If you want to retrieve only the first 2 entries, specify the following parameters: Set limit to 2 to retrieve only 2 entries. Set offset to 0 to retrieve entries that start from the beginning. Your API call might look like this: The REST client might retrieve the following 2 entries: Code: 200 Content:{ "total_count": 88, "results": [ { "status": "Active", "dimensionname": "Accuracy", "systemname": "Finance", "datasetname": "FX EOD Revenue", "attributename": "Fee", "id": 22, "referencenumber": "fin_dqr_8", "criticality": 3, "technicaldesc": "Technical description", "createddatetime": " T11:41: ", "lastupdatedatetime": " T11:41: ", "dqmeasureperiodicity": { "_id": 3, "_primary_name": "Monthly", "_description": "Monthly" "primaryname": "Threshold for marketing expenses", "description": "This is DQ Rule number 22" { "status": "Active", "dimensionname": "Timeliness", "systemname": "Finance", "datasetname": "FX EOD Revenue", "attributename": "Cost Center", "id": 23, "referencenumber": " fin_dqr_9", 4

5 "criticality": 2, "technicaldesc": "Technical description", "createddatetime": " T11:41: ", "lastupdatedatetime": " T11:41: ", "dqmeasureperiodicity": { "_id": 3, "_primary_name": "Monthly", "_description": "Monthly" "primaryname": "Period for submitting expense report", "description": "This is DQ Rule number 23" } ]} The important properties in this example are as follows: Code: 200 indicates that the request was successfully sent. Total_count indicates the number of data quality rules that are present in Axon. In this example, 88 data quality rules are present in Axon. primaryname indicates the name of the data quality rule. In this example, the Threshold for marketing expenses and Period for submitting expense report are the names of the data quality rules that were retrieved. referencenumber indicates the unique identifier that Axon assigns to each data quality rule. In this example, the rules have the fin_dqr_8 and fin_dqr_9 identifiers. systemname indicates the system that the data quality rule belongs to. In this example, both rules belong to the Finance system. datasetname indicates the data set that the data quality rule applies to. In this example, the rules belong to the FX EOD Revenue data set. attributename indicates the attribute of the data set that the data quality rule applies to. In this example, the data sets have the Fee and Cost Center attributes. Note: The systemname, datasetname, and attributename properties are retrieved for local data quality rules. Standard data quality rules do not have these properties associated to them. 5