Library Entity Business Rules

/api/repositories/{repository}/library/entities/{libraryID}/businessrules
Parameter Type Purpose
repository string The name of the Repository
libraryID int The ID of the library entity

Get/Post

GET /api/repositories/(string: repository)/library/entities/(int: libraryID)/businessrules

Lists all business rules in the Library Entity 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 standard request body.

GET /api/repositories/jupiter/library/entities/2/businessrules HTTP/1.1
Accept: application/json
Response Code Reason
200 No error
500 Server error

The response will be a Standard Response. The columns array will contain the following:

Human Name Column Name Description
Name actual_name Test name.
Description actual_description Test Description.
Threshold threshold_percent Compliance ThresholdPercentage.
Enabled _model_check True if the test is enabled.
Priority actual_priority Priority of the rule.
Priority Description _priority_description Description of the priority
Index Control _model_index_control Compliance Threshold Percentage.
Index Threshold _model_index_threshold Compliance Threshold Percentage.
Expression predicate The Business Rule Test.
Filtering _model_is_filtering Are the rows being filtered.
Filter Expression _model_filter_predicate The Business Rule Filter.
Grouping _model_is_grouping Are the rows being grouped.
Group Function _model_group_function Business Rule Group-by function
Aggregating _model_is_aggregating Are the rows being aggregated
Aggregate Method _model_aggregate_method Method used to aggregate.
Aggregate Function _model_aggregate_function Business Rule Aggregate function
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.
XML actual_predicate Business Rule represented in XML.
Sequence Number seqno Sequence number identifying the rule.
Identifier actual_uuid The rule identifier.
Local identifier _local_identifier A unique identifier for the rule.
Rule Categories _rule_categories Business Rule categories.
Associations _associations Are there any associations for this rule.

Each element in the rows array contains the data for a single Library Entity Business Rule.

{
    "dataRow": [
        "MyRule",
        "",
        "100",
        "yes",
        "1",
        "{}",
        "Normal",
        "",
        "<expr><text>Row &lt;&gt; 0</text><ne><var>:rowid:</var><int>0</int></ne></expr>\r\r\n",
        "no",
        "",
        "no",
        "",
        "no",
        "",
        "",
        "bob",
        "2014/11/06 12:25:13",
        "",
        "",
        "<expr><text>Row &lt;&gt; 0</text><ne><var>:rowid:</var><int>0</int></ne></expr>\r\r\n",
        "1",
        "c1ca546a-5402-4f96-a428-251b6496448f",
        "",
        "",
        "1"
    ],
    "metadata": {
        "url": "/api/repositories/jupiter/library/entities/2/businessrules/1"
    }
}

If there are no business rules, or the Library Entity does not exist, the rows array will be empty.

Commands

See the Library Business Rule Commands for the contents of the request for each command.