Library Business Rule Group Results
===================================

.. code-block:: http

    /api/repositories/{repository}/rulegroups/{folderID}/businessrules/results

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

    repository, the name of the :doc:`repository`
    folderID, the ID of the :doc:`rule group <rulegroup>` folder

Get/Post
~~~~~~~~

.. http:get:: /api/repositories/(string:repository)/rulegroups/(int:folderID)/businessrules/results
    :synopsis: List results of business rules in a group folder

    Returns the results of business rules in a group folder
    The GET request supports page and pageSize parameters on the URL. If you require a subset of this data (filtering, sorting, or columns), POST to this url with the :doc:`standard request <standard-request>` body (see below).

.. code-block:: http

    GET /api/repositories/jupiter/rulegroups/1/businessrules/results HTTP/1.1
    Accept: application/json

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

    200, No error
    500, Internal server error

The response will be a :doc:`standard-response`, with a list of the business rules in the group. The response will not include business rules in sub-folders.

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

    "Rules", "actual_name", "Rule Name"
    "Threshold", "_actual_threshold", "Compliance Threshold Percentage."
    "Derived", "_inheriting", "Is this rule derived from a library entity."
    "Library", "_eLibDispName", "Associated library entity containing this rule."
    "Enabled", "_check", "True if the test is enabled."
    "Priority", "actual_priority", "Priority of the rule."
    "Description", "_result", "Rule Description"
    "Passing Fraction", "_actual_fraction", "Percentage of Rows that pass in the Group."
    "Passing Fraction", "_dirty_flag", "Percentage of Rows that pass in the Group."
    "Created By", "CREATED_BY", "Who created this business rule"
    "Date Created", "_created_date", "When this business rule was created"
    "Edited By", "EDITED_BY", "Who changed this business rule"
    "Date Changed", "_edited_date", "When this business rule was changed"
    "Entity ID", "entity_id", "Entity Identifier."
    "Rule ID", "seqno", "Rule Identifier."

Each data row will contain a business rule and its result.

.. code-block:: json

    {
        "dataRow": [
        "testrule",
        "50",
        "yes",
        "New Entity Name(2)",
        "yes",
        "1",
        "passed",
        "",
        "analysis reqd",
        "bob",
        "2014/12/17 09:54:47",
        "",
        "",
        "1",
        "2"
        ],
        "metadata": {
        "url": "/api/repositories/jupiter/entities/1/businessrules/2"
        }
    }

If there are no rules in the folder, ``rows`` will be an empty string.

Post
~~~~

.. http:post:: /api/repositories/(string:repository)/rulegroups/(int:folderID)/businessrules/results
    :synopsis: List results of business rules in a group sub-folder

    Returns the results of business rules in a group sub-folder
    If you require a subset of this data (filtering, sorting, or columns), define one or more :doc:`standard request <standard-request>` options.

.. code-block:: http

    POST /api/repositories/jupiter/rulegroups/1/businessrules/results HTTP/1.1
    Content-Type: application/json

    {
        "command": "get",        "data": {
            "option": "-all"
        }
    }

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

    200, No error
    500, Internal server error

The response will be a list of the rules in the folder and all sub-folders.