rules

Get available rules, optionally filtered by tags and/or prefix.

get/rules

Request

  • Base URL
    /rest (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    OAuth 2
    Authorization code/auth/authorize
    Token URL/rest/auth/token
    Scopesadmin
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

prefixstring
tagsstring[]
summaryboolean

summary fields only

staticDataOnlyboolean

provides a cacheable list of values not expected to change regularly and honors the If-Modified-Since header, all other parameters are ignored

Response

OK

configurationobject
templateUIDstring
uidstring
namestring
tagsstring[]
visibility'VISIBLE' | 'HIDDEN' | 'EXPERT'
descriptionstring
editableboolean

Changes

No recorded changes to this operation across all 7 revisions of this API.