Entiry - Rules

Minimum API version 4.0

VerbRequestNotesPermissions Required
GET/Consumer/Rules/{id}Returns a specific RuleRequires 'Read' permission on 'GuaranteedState' securable type
GET/Consumer/RulesReturns all RulesRequires 'Read' permission on 'GuaranteedState' securable type
POST/Consumer/Rules/Search

Returns Rules that match the search parameters specified.

  • filter - filter expression.To learn about how to define filter check Using scope and filter expressions page.
  • sort - sort expression. To learn about how to define sort criteria check Sort Definition page.
  • start - starting index to support pagination. It begins from 1.
  • pagesize - number of results to fetch

Allowed filter columns:

  • Name
  • Type
  • ReadablePayload
  • Enabled

Allowed sort columns:

  • Name
  • Type
  • ReadablePayload
  • Enabled
Requires 'Read' permission to 'GuaranteedState' securable type
POST/Consumer/Rules/Shallow/Search

Returns Rules that match the search parameters specified.

This endpoint returns only superficial information about Fragments used by the Rule. For detailed infirmation please use /Rules/Search instead.

  • filter - filter expression.To learn about how to define filter check Using scope and filter expressions page.
  • sort - sort expression. To learn about how to define sort criteria check Sort Definition page.
  • start - starting index to support pagination. It begins from 1.
  • pagesize - number of results to fetch

Allowed filter columns:

  • Name
  • Type
  • ReadablePayload
  • Enabled

Allowed sort columns:

  • Name
  • Type
  • ReadablePayload
  • Enabled
Requires 'Read' permission to 'GuaranteedState' securable type
POST/Consumer/RulesCreates a new RuleRequires 'Write' permission to 'GuaranteedState' securable type
DELETE/Consumer/Rules/{id}Deletes a RuleRequires 'Delete' permission on 'GuaranteedState' securable type
POST/Consumer/Rules/{id}/Enable/{enable}If 'enable' is set to True it enables given Rule. If it is set to False the Rule will be disabled.Requires 'Write' permission to 'GuaranteedState' securable type
GET/Consumer/Rules/Unlicensed

Minimum API version 5.1

Retrieves a list of Ids of Rules that use unlicensed Fragments

Requires 'Read' permission on 'GuaranteedState' securable type