Library Rule Group
==================

.. code-block:: http

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

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

    repository, string, the name of the :doc:`repository`
    folderID, int, The ID of the desired rule group


.. _lrg_rename:

Commands
~~~~~~~~

.. code-block:: http

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

    {
        "command": "rename",
        "data": {
            "name": "rulegp3",
        }
    }

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

    204, No error
    400, Invalid data passed with request
    500, Server error

The request requires a :doc:`standard-request` packet. Available commands are:

.. csv-table::
    :header: Command, Description
    :widths: 30, 70

    rename, Rename an existing library rule group

The request packet must contain the :code:`command` and :code:`data` elements. The :code:`options` element is not required.

The :code:`name` field is required. It should contain the name to which the rule group is to be renamed


.. _lrg_delete:

Delete
~~~~~~

.. http:delete:: /api/repositories/(string:repository)/rulegroups/(int:folderID)
    :synopsis: Delete the rule group

    Delete the library rule group

.. code-block:: http

    DELETE /api/repositories/jupiter/rulegroups/1 HTTP/1.1

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

    204, Success
    400, Invalid parameters
    500, Server error