Rule Books

List Rules

The rules in a version (default current), in the order they were added, each with its derived status.

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

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Path parameters

rule_book_idstring required

The rule book id (rbk_…).

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).

in_nash'must' | 'aim_for' | 'report' | 'not_in_nash'

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.

qstring nullable

Text in the name, the customer's words or the key.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.