Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.

Table of Contents

Search

  1. Introduction
  2. Define settings for data collections
  3. Manage Data Marketplace content
  4. Manage data collections
  5. Manage requests, orders and consumer accesses
  6. Miscellaneous APIs
  7. Frequently Asked Questions

API Reference

API Reference

Request

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
dataElementId
Required. The system generated unique identifier of the data element for which you want to specify a data quality score.
For more information about how you can use an API to get the unique identifier of a data element, see Retrieve data elements.
ruleRefId
Required. The reference identifier of the data quality rule that is run on the data element, as defined in the external data quality system.
-
ruleName
Required. The name of the data quality rule that is run on the data element.
-
ruleDescription
Optional. The description of the data quality rule that is run on the data element.
-
type
Required. The dimension for which the data quality rule is run.
You can enter one of the following values:
  • Accuracy
  • Validity
  • Completeness
  • Consistency
  • Uniqueness
  • Timeliness
score
Required. The data quality score.
Enter a value from 0 through 100.
rowCount
Required. The number of rows on which the data quality rule is executed.
-
exceptionCount
Required. The acceptable number of unresolved data quality issues in your data.
-
executionDate
Optional. The date when the data quality rule is executed.
-
thresholds
Required. A threshold is the minimum acceptable data quality score of a data element.
The thresholds that you define help users to distinguish helpful data from the unhelpful data.
thresholds > name
Required. The name of the color used by
Data Marketplace
to represent a threshold.
You can enter only the following values:
  • The
    GREEN
    value indicates that the data quality score is above the target value, represents a "Good" score.
  • The
    AMBER
    value indicates that the data quality score is between the threshold and target value, represents an "Acceptable" score.
thresholds > value
Required. The minimum acceptable data quality score.
You must specify a value for both the
GREEN
and
AMBER
threshold.

0 COMMENTS

We’d like to hear from you!