Model: FlagEnvironment

1 min

Model Parameters

FlagEnvironment
- created_timestring<date-time>
  Example
  2019-05-08T00:00:00.000Z
  Format
  date-time
- disable_urlobject
  Description
  Link to disable this flag in the environment
  - UrlValue
- enable_urlobject
  Description
  Link to enable this flag in the environment
  - UrlValue
- enabledboolean
- has_restricted_permissionsboolean
- idinteger<int64>
  Description
  The ID of the Environment
  Format
  int64
- keystringrequired
  Example
  production
- namestringrequired
  Example
  Production"
- priorityintegerrequired
  Example
  1
  Description
  Integer representing the priority of the Environment. This is used for ordering in the UI.
- rules_detailRuleDetails[]
  - audience_idsinteger[]required
    Example
    [ 1, 2, 3 ]
  - created_by_user_emailstring
    Example
    [email protected]
  - created_timestring<date-time>
    Description
    Timestamp when the Rule is created
    Format
    date-time
  - days_runninginteger
    Example
    30
  - distribution_modestring<manual | stats_accelerator>
    Description
    Type of rule distribution. Only a/b experiment can show distribution_mode field in the response
    Allowed
    manualstats_accelerator
  - enabledbooleanrequired
    Example
    true
  - fetch_results_ui_urlobject
    Description
    A url to be used to find a particular Results page. This field is optional and returned only if rule has results
    - UrlValue
  - idinteger
    Example
    45633994
  - keystringrequired
    Example
    rule_key
  - layer_experiment_idinteger
    Example
    123
  - namestringrequired
    Example
    Sample Rule
  - primary_metricstring
    Example
    conversion_rate
  - statusstring
    Example
    draft
    Description
    Status of the rule
  - traffic_allocationintegerrequired
    Example
    50
  - typestringrequired
    Example
    rule_type
  - updated_timestring<date-time>
    Description
    Timestamp when the Rule is updated
    Format
    date-time
  - variation_namesstring[]required
    Description
    A list of variation names
- rules_summarymap<string, RulesetSummary>
  Description
  Map of rules that include rule type as key and summary as value
- statusstring
  Example
  draft
  Description
  Status of the Flag