Get rules (getrules)

List style guide rules, optionally filtered by rule ID.

List style guide rules.

Request

See HTTP API Overview.

Parameters

Parameter	Type	Required	Default	Notes
cmd	string	Yes	style_guide	Command name.
action	string	Yes	getrules	Action name.
lang	string	No		Language scope to list rules for (example: en_US or en). By default returns all rules from every language.
rule	string	No		One rule ID, or a comma-separated list of rule IDs. Filter is applied within the selected lang.

Behavior

• Without lang: lists rules in common.

• Without rule: returns all rules for the selected lang, grouped by style guide.

• With rule: returns only the matching rule(s) for the selected lang.

Response

Multiple rule objects are returned.

See Response schema.

Errors

See Errors.

Examples

Example: get all rules

{
  "cmd": "style_guide",
  "action": "getrules"
}

Example: get specific rules

{
  "cmd": "style_guide",
  "action": "getrules",
  "lang": "en_US",
  "rule": "STYLE_111,STYLE_222"
}