Library Rule Groups

/api/repositories/{repository}/rulegroups

Parameter	Type	Purpose
repository	string	the name of the Repository

Get

GET /api/repositories/(string: repository)/rulegroups

Returns a list of all library rule groups in a Repository

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

Response Code	Reason
200	No error

The response will be a Standard Response.

The columns displayed for each Library Entity are:

Human Name	Column Name	Description
Name	name	The name for the library rule group
Description	description	Description of the library rule group
Folder ID	fid	Rule Group Identifier
Parent Folder ID	parent_eid	Rule Group Identifier of the parent rule group

The rows array will contain one element for each Library Rule Group:

{
    "dataRow": [
        "rulegroup1",
        "My rule group",
        "1",
        "0",
    ],
    "metadata": {
        "url": "/api/repositories/jupiter/rulegroups/1"
    }
}

If there are no library rule groups, the ‘rows’ value will be an empty array.

Commands

POST /api/repositories/(string: repository)/rulegroups

Add a library rule group

JSON Parameters:  

• body – The request body

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

{
    "command": "add",
    "data": {
        "name": "rulegp3",
        "description": "new rule group",
        "folderID": "1"
    }
}

Response Code	Reason
204	No error
400	Invalid data passed with request
500	Server error

The request requires a Standard Request packet. Available commands are:

Command	Description
add	Add new library rule group

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

The name and folderID fields are required. description field is optional.

folderID is the ID of the parent folder where the new rule group is to be created.