Model: Flags

1 min

Model Parameters

Flags
- countintegerrequired
  Example
  2
  Description
  Number of Flags on the current page.
- create_urlobject
  - UrlValue
- fetch_flag_urlobject
  Description
  A url template to be used to find a particular Flag.
  - UrlValue
- filter_urlobject
  Description
  Url template like '.../{?filter}'
  - UrlValue
- first_urlobjectrequired
  Description
  Link to first page of Flags in a series.
  - UrlValue
- itemsFlag[]required
  - account_idinteger<int64>
    Description
    The ID of the Account this Flag belongs to
    Format
    int64
  - archive_urlobject
    - UrlValue
  - archivedboolean
  - created_by_user_emailstring
    Example
    [email protected]
  - created_timestring<date-time>required
    Example
    2019-05-08T00:00:00.000Z
    Format
    date-time
  - delete_urlobject
    - UrlValue
  - descriptionstring
    Example
    Flag used for driving customers to use recurring deposits by showing a graph of compound interest over time
  - environmentsmap<string, FlagEnvironment>required
  - idintegerrequired
    Example
    45633994
  - is_permanentboolean
    Description
    When true, marks the flag as intentionally permanent (e.g. a kill switch or operational toggle) so governance tooling excludes it from stale scoring and archive recommendations.
    Default
    false
  - keystringrequired
    Example
    recurring_deposit
  - namestringrequired
    Example
    Recurring Deposit
  - outlier_filtering_enabledboolean
    Default
    false
  - owner_user_idstring
    Example
    1234-abcd-5678-efgh
    Description
    Unique user ID of the flag owner. This is the user's unique identifier, not their email address. If no value was provided during creation, this defaults to the user who created the flag.
  - project_idinteger<int64>
    Description
    The ID of the Project this Flag belongs to
    Format
    int64
  - revisioninteger
    Description
    Revision number for tracking changes
  - rolestring
    Example
    admin
    Description
    Granular permission role
  - team_idsstring[]
    Example
    [ "1234567890", "0987654321" ]
    Description
    List of team IDs associated with this flag
    Default
  - unarchive_urlobject
    - UrlValue
  - update_urlobject
    - UrlValue
  - updated_timestring<date-time>required
    Example
    2019-05-08T00:00:00.000Z
    Format
    date-time
  - urlobjectrequired
    Description
    Link to self
    - UrlValue
  - urnstringrequired
    Example
    flags.flag.optimizely.com::asdfsdf-2344-efadf03-343434-efrrr
    Description
    The URN for the Flag
  - variable_definitionsmap<string, VariableDefinition>
    Default
    {}
- last_urlobjectrequired
  Description
  Link to the last page of Flags in a series.
  - UrlValue
- next_urlobject
  Description
  List of links to next pages of Flags in a series.
  
  The first element in the array is the exact next page after the current record, etc.
  - UrlList
- pageintegerrequired
  Example
  5
  Description
  Number of the current page. 1-index based.
- prev_urlobject
  Description
  List of links to previous pages of Flags in a series.
  
  The first element in the array is the exact previous page before the current record, etc.
  - UrlList
- reset_urlobject
  Description
  Link to the default pages of Flags
  - UrlValue
- sort_urlobject
  Description
  Url template like '.../{?sort}'
  - UrlValue
- total_countintegerrequired
  Example
  20
  Description
  Total number of Flags for this series.
- total_pagesintegerrequired
  Example
  10
  Description
  Total number of pages for this series.
- urlobjectrequired
  Description
  Link to self
  - UrlValue