Attribute Phrases
=================

.. code-block:: http

    /api/repositories/{repository}/entities/{entity}/attributes/{attribute}/phrases

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

    repository, string, The :doc:`repository <repository>` name
    entity, int, The :doc:`entity <entity>` ID
    attribute, int, The :doc:`attribute <attributes>` ID

.. http:get:: /api/repositories/(string:repository)/entities/(int:entityID)/attributes/(int:attributeID)/phrases
    :synopsis: Get all phrases for an attribute

    Gets a complete list of phrases for an attribute.

.. code-block:: http

    GET /api/repositories/jupiter/entities/1/attributes/55/phrases HTTP/1.1
    Accept: application/json

The list of phrases may be quite long; if so, the list can be paged:

.. http:post:: /api/repositories/(string:repository)/entities/(int:entityID)/attributes/(int:attributeID)/phrases
    :synopsis: Get a partial list of phrases for an attribute

    Get a page of phrases for an attribute

.. code-block:: http

    POST /api/repositories/jupiter/entities/1/attributes/55/phrases HTTP/1.1
    Content-Type: application/json

    {
        "command": "get",
        "options": {
            "pageStart": 1,
            "pageSize": 32
        }
    }

The response is a :doc:`standard-response`.

The ``columns`` array will show the following columns:

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

    "Phrase", "_value", "The phrase found in the values"
    "Words", "_words", "The number of words in the phrase"
    "Value Count", "VALUE_COUNT", "The number of values that contained this phrase"
    "Frequency", "FREQUENCY_COUNT", "The number of rows that contained this phrase"
    "Dist %", "_distribution", "A measure of how much of the attribute contains this phrase"

A ``datarow`` element will look like:

.. code-block:: json

    {
        "dataRow": [
            "LIN",
            "1",
            "119",
            "460",
            "32.463"
        ]
    }