USusenash
Rule Books

Get Rule

Changed on

One rule at a version (default current). Its etag is what If-Match takes when you change it.

get/v1/rule-books/{rule_book_id}/rules/{rule}

Request

Path parameters

rule_book_idstring required

The rule book id (rbk_…).

rulestring required

The rule's id (rul_…), key or alias.

Query parameters

version'current' | 'draft' | 'working'

Which version a read means: the one in use, the draft, or the draft if there is one, else the one in use.

current, draft or working (the draft, else current).

Response

OK

idstring required
keystring required
aliasesstring[] required
rule_book_idstring required
revision_idstring required
revision_numberinteger required
added_in_versioninteger nullable required

The version that added the rule.

revised_in_versioninteger nullable required

The version that made this revision: later than added_in_version once the rule is edited.

namestring required
in_nash'must' | 'aim_for' | 'report' | 'not_in_nash' required

How Nash plans with a rule. Must is never broken, Aim for is kept unless it costs a lot, and Report is checked after planning.

howstring nullable required
etagstring required

Changes