Model: Variations

1 min

Model Parameters

Variations
- countintegerrequired
  Example
  1
  Description
  Number of Variations on the current page.
- create_urlobject
  Description
  Url template to create Variation for a Flag
  - UrlValue
- fetch_variation_urlobject
  Description
  A url template to be used to find a particular Variation.
  - UrlValue
- filter_urlobject
  Description
  Link to the default page of Variations with filter '.../{?filter}'
  - UrlValue
- first_urlobjectrequired
  Description
  Link to first page of Variations in a series.
  - UrlValue
- itemsVariation[]required
  - archive_urlobject
    Description
    Link to archive this Variation
    - UrlValue
  - archivedboolean
    Description
    Indicates if the Variation is archived or not
  - created_timestring<date-time>required
    Description
    Timestamp when the Variation is created
    Format
    date-time
  - delete_urlobject
    Description
    Link to delete this Variation
    - UrlValue
  - descriptionstring
    Description
    Additional context of the Variation
  - enabledboolean
    Description
    Indicates if the Variation is enabled or not
  - environment_usage_countmap<string, integer>
    Example
    { "development": 15, "production": 20 }
    Description
    Map of rule/ruleset count associated with the variation in each environment that includes environment key as key and count as value
  - fetch_flag_urlobject
    Description
    Link to flag url of this variation
    - UrlValue
  - flag_keystringrequired
    Description
    The Key of the Flag this Variation belongs to
  - idintegerrequired
    Description
    System generated Unique ID of the Variation
  - in_useboolean
    Description
    Indicates if the Variation is in use by a rule or a ruleset
  - keystringrequired
    Description
    User-facing Unique identifier of the Variation
  - namestringrequired
    Description
    User-facing name of the Variation
  - revisioninteger
    Description
    Revision number for tracking changes
  - rolestring
    Example
    admin
    Description
    Granular permission role
  - screenshot_namestring
    Example
    hero-banner.png
    Description
    Original filename of the uploaded screenshot image. Null when no screenshot has been attached.
    Max Length
    255
  - screenshot_urlstring
    Example
    /projects/123/files/a1b2c3d4-e5f6-7890-abcd-ef1234567890
    Description
    Backend proxy path to the variation's uploaded screenshot image. Null when no screenshot has been attached. Format: /projects/{project_id}/files/{file_id}
    Max Length
    2000
  - unarchive_urlobject
    Description
    Link to unarchive this Variation
    - UrlValue
  - update_urlobject
    Description
    Link to update this Variation
    - UrlValue
  - updated_timestring<date-time>required
    Description
    Timestamp when the Variation is updated
    Format
    date-time
  - urlobjectrequired
    Description
    Link to self
    - UrlValue
  - urnstringrequired
    Description
    The URN for the Variation
  - variablesmap<string, VariableValue>
    Description
    Map of flag variables that include variable key and value
- last_urlobjectrequired
  Description
  Link to the last page of Variations in a series.
  - UrlValue
- next_urlobject
  Description
  List of links to next pages of Variations in a series.
  
  The first element in the array is the exact next page after the current record, etc.
  - UrlList
- pageintegerrequired
  Example
  1
  Description
  Number of the current page. 1-index based.
- prev_urlobject
  Description
  List of links to previous pages of Variations 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 page of Variations
  - UrlValue
- sort_urlobject
  Description
  Link to the default page of Variations with sort '.../{?sort}'
  - UrlValue
- total_countintegerrequired
  Example
  1
  Description
  Total number of Variations for this series.
- total_pagesintegerrequired
  Example
  1
  Description
  Total number of pages for this series.
- urlobjectrequired
  Description
  Link to self
  - UrlValue