Permanent Entity Keys
=====================

.. code-block:: http

    /api/repositories/{repository}/entities/{entity}/keys/permanent

.. csv-table::
    :header: Parameter, Type, Purpose
    :widths: 20, 20, 60
    :stub-columns: 1

    repository, string, the name of the :doc:`repository`
    entity, int, The ID of the entity to view

Get
~~~

.. http:get:: /api/repositories/(string:repository)/entities/(int:entityID)/keys/permanent
    :synopsis: Lists permanent keys of an entity

    Lists permanent keys of the corresponding :doc:`entity`

.. code-block:: http

    GET /api/repositories/jupiter/entities/1/keys/permanent HTTP/1.1
    Accept: application/json

.. csv-table::
    :header: Response Code, Reason
    :widths: 25, 75

    200, No error
    500, Server error

The response will be a :doc:`standard-response`, with a list of permanent keys in the corresponding :doc:`entity`.

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

.. csv-table::
    :header: Human Name, Column Name, Description
    :widths: 25, 25, 50

    "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 will contain the list of permanent keys of the corresponding :doc:`entity`:

.. code-block:: json

    "rows": [
    {
        "dataRow": [
            "Key",
            "Permanent",
            "Yes",
            "220",
            "50.000",
            "1",
            "2",
            "5",
            "2015/03/10 16:46:36",
            "bob@TEST-7",
            "",
            "1"
        ],
        "metadata": {
            "url": "/api/repositories/jupiter/entities/22/keys/-1/duplicates"
        }
    }

``metadata`` contains the url to drill down to each row.

If there are no permanent keys in the :doc:`entity`, ``rows`` will be an empty string.