Attribute Keys

All Attribute Keys

/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/keys
Parameter Type Purpose
repository string the name of the Repository
entity int The ID of the entity to view
attribute int The ID of the attribute to view

Get

GET /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)/keys

Lists discovered and permanent keys of the corresponding attribute

GET /api/repositories/jupiter/entities/1/keys HTTP/1.1
Accept: application/json
Response Code Reason
200 No error
500 Server error

The response will be a Standard Response, with a list of discovered and permanent keys in the corresponding Attributes.

Columns

The columns array will contain the list of columns for each data row.

Human Name Column Name Description
Lh Attrs _lhnames The attributes that form the primary key
Status __STATUS Whether the key is Discovered or Permanent.
Verified _verified Whether the key quality has been verified against all rows.
Ref JOB_ID The key analysis reference number.
Quality % GOODNESS A measure of how well the attributes form a key
Keys CONFIRMATIONS The number of non-duplicated keys.
Duplicate Keys SETS The number of distinct key values that are duplicated.
Duplicate Rows CONTRADICTIONS The number of rows with duplicate keys.
Verified Date _checked_date When the key rule was last verified.
Verified By CHECKED_BY Who verified the key rule.
Created Date _created_date When the key rule was created.
Created By CREATED_BY Who created the key rule.
Rh Attr ID RH_ATTR IDs of the right hand attributes that form the primary key
Lh Attr IDs LH_ATTRS IDs of the left hand attributes that form the primary key

Data Row

The data row will contain the list of all keys of the corresponding Attributes:

"rows": [
{
    "dataRow": [
        "Line 02,Line 03",
        "Permanent",
        "Yes",
        "1",
        "100.000",
        "50",
        "",
        "",
        "2015/02/05 11:53:01",
        "bob@TEST-7",
        "2015/02/05 11:53:01",
        "bob@TEST-7",
        "",
        "2 3"
    ],
    "metadata": {
        "url": "/api/repositories/test/entities/1/keys/-2_3/duplicates"
    }
},
{
    "dataRow": [
        "Line 02,Line 04",
        "Discovered",
        "Yes",
        "1",
        "100.000",
        "50",
        "",
        "",
        "2015/02/05 11:53:01",
        "bob@TEST-7",
        "2015/02/05 11:53:01",
        "bob@TEST-7",
        "",
        "2 4"
    ],
    "metadata": {
        "url": "/api/repositories/test/entities/1/keys/-2_4/duplicates"
    }
}

metadata contains the url to drill down to each row.

If there are no discovered or permanent keys in the corresponding Attributes, rows will be an empty string.

Permanent Keys of an Attribute

/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/keys/permanent
Parameter Type Purpose
repository string the name of the Repository
entity int The ID of the entity to view
attribute int The ID of the attribute to view

Get

GET /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)/keys/permanent

Lists permanent keys of the corresponding attribute

GET /api/repositories/jupiter/entities/1/attributes/1/keys/permanent HTTP/1.1
Accept: application/json
Response Code Reason
200 No error
500 Server error

The response will be a Standard Response, with a list of permanent keys in the corresponding Attributes.

The columns array will contain the list of columns for each data row as listed in above columns.

The data row will contain the list of permanent keys in the corresponding Attributes similar to ones listed in above data row

Discovered Keys of an Attribute

/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/keys/discovered
Parameter Type Purpose
repository string the name of the Repository
entity int The ID of the entity to view
attribute int The ID of the attribute to view

Get

GET /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)/keys/discovered

Lists discovered keys of the corresponding attribute

GET /api/repositories/jupiter/entities/1/attributes/1/keys/discovered HTTP/1.1
Accept: application/json
Response Code Reason
200 No error
500 Server error

The response will be a Standard Response, with a list of discovered keys in the corresponding Attributes.

The columns array will contain the list of columns for each data row as listed in above columns.

The data row will contain the list of discovered keys in the corresponding Attributes similar to ones listed in above data row