Model: Ruleset

1 min

Model Parameters

Ruleset
- archivedboolean
  Description
  Whether this Ruleset is archived or not. The ruleset is archived if the Flag was archived.
- default_variation_keystring
  Example
  high_discount
  Description
  User-facing Unique identifier of the Variation.
- default_variation_namestring
  Example
  High Discount
  Description
  User friendly identifer of the Variation.
- disable_urlobject
  - UrlValue
- enable_urlobject
  - UrlValue
- enabledboolean
  Description
  Indicates if the rule is enabled or not in an environment.
  Default
  false
- environment_idnumber
  Description
  Environment id.
- environment_keystringrequired
  Example
  production
  Description
  User-facing Environment identifier.
- environment_namestring
  Example
  Production
  Description
  Environment name.
- fetch_default_variation_urlstring
  Description
  A url to the variation that will be executed if no rule audience is served.
- fetch_flag_urlobject
  Description
  A url to fetch the Flag used by this Ruleset.
  - UrlValue
- flag_keystringrequired
  Example
  recurring_deposit
  Description
  User-facing Unique identifier of the Flag.
- idinteger
  Example
  23456746
- revisioninteger
  Description
  Revision number for tracking changes
- rolestring
  Example
  admin
  Description
  Granular permission role
- rule_prioritiesstring[]required
  Example
```
[
  "new_users",
  "paid_users",
  "trial_users"
]
```
  Description
  Ordered array of rule keys for the set.
- rulesobject
  - RuleMap
- statusstring<draft | running | paused>
  Description
  status of ruleset.
  Allowed
  draftrunningpaused
- update_urlobject
  - UrlValue
- updated_timestring<date-time>
  Example
  2019-05-08T00:00:00.000Z
  Description
  Timestamp when the Ruleset was last updated
  Format
  date-time
- urlobjectrequired
  Description
  Link to self
  - UrlValue
- urnstringrequired
  Example
  ruleset.flag.optimizely.com::a308d9ae-89ba-11ea-bc55-0242ac130003
  Description
  The URN for the Ruleset

Rules configuration specific to an environment.