Rules

Get all the rules for a rule set

Returns the collection of rules for a specified rule set.

get/ruleSets/{ruleSetId}/rules

Request

  • Base URL: https://example.com/businessRules
  • URL: https://example.com/businessRules/ruleSets/{ruleSetId}/rules
  • Auth: none declared

Path parameters

ruleSetIdstring required

The ID of the rule set to match.

Query parameters

startinteger

The starting index of the first item on a page. The index is 0-based. The default is 0.

limitinteger

The maximum number of items to return on this page. The actual number of returned items might be less if there are no more items in the collection. The default is 10.

filterstring filter-criteria

The criteria for filtering the function categories. See Filtering in REST APIs.

sortBystring sort-criteria

The criteria for sorting the function categories. See Sorting in REST APIs.

Headers

Accept-Itemstring

An alternative media type that the API recognizes. If the media type is not one that the API can provide, a 406 response is returned.

Response

The request succeeded.

namestring

The name of the collection.

startinteger

The zero-based index of the first item in the collection.

limitinteger

The number of items that were requested for the collection.

countinteger

If populated indicates the number of items in the collection.

acceptstring

A space-delimited list of media types from which an Accept header may be constructed.

versioninteger

The version number of the collection representation. This representation is version 2.

Example response

{
  "items": [
    {
      "name": "Age Requirements",
      "conditional": "if",
      "ruleFiredTrackingEnabled": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.