Rules

Get all rules

Returns all rules based on a query for all rule sets.

get/rules

Request

  • Base URL: https://example.com/businessRules
  • URL: https://example.com/businessRules/rules
  • Auth: none declared

Query parameters

startinteger

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

limitinteger

The number of items to return on each page.

filterstring filter-criteria

An expression for filtering the collection. Valid expressions include eq(member,"string"). Allowed members are id, name, description, modifiedTimeStamp, creationTimeStamp, modifiedBy, and createdBy.

sortBystring sort-criteria

The criteria for sorting the rule sets. Valid sortBy parameters include sortBy=id:descending. Allowed members are id, name, description, modifiedTimeStamp, creationTimeStamp, modifiedBy, and createdBy.

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.