Model: ScheduledChange

1 min

Model Parameters

ScheduledChange
- idintegerrequired
  Description
  The unique identifier for the schedule.
- account_idintegerrequired
  Description
  The account the Project is associated with.
- project_idintegerrequired
  Description
  The id of the project for which the schedule is set.
- flag_keystringrequired
  Description
  The Flag identifier
- environmentstringrequired
  Description
  The Environment of the flag
- actionsScheduleAction[]required
  Description
  Schedule actions.
  - subjectobjectrequired
    Description
    The entity this action will apply to
    - keystring
      Description
      The identifier of the subject
    - typestring<flag | rule>
      Description
      The type of subject. Can be a flag or a rule of the flag
      Allowed
      flagrule
  - changed_elementstring<status | percentage_included | audience_conditions>required
    Allowed
    statuspercentage_includedaudience_conditions
  - valueActionValuerequired
    Description
    Value of the action. Can be of any type.
    - object
    - object
- scheduleobjectrequired
  Description
  Schedule details.
  - ScheduledTimeWithUTC
    - timestringrequired
      Example
      07:02
      Description
      The schedule will run at this time. Expected format: hh
      (24 hour)
    - time_zonestringrequired
      Example
      Etc/UTC
      Description
      The timezone information for the scheduled time. Must be an IANA timezone.
    - datestringrequired
      Example
      2023-07-30
      Description
      The schedule will run at this date. Expected format: yyyy-mm-dd.
    - utc_timestringrequired
      Example
      2023-07-30T07:02:00+0000
      Description
      The utc timestamp when the scheduled job will be executed.
- statusstringrequired
  Description
  The status of the scheduled job.
- approval_statusstring<pending | accepted | rejected | withdrawn>
  Description
  The current approval status for a change-request-backed schedule. Present only when approval is required; null for non-gated or pure-legacy schedules.
  Allowed
  pendingacceptedrejectedwithdrawn
- completed_atstring<date-time>required
  Example
  2023-04-15T20:14+0000
  Description
  The UTC timestamp when the schedule is completed.
  Format
  date-time
- updated_atstring<date-time>required
  Example
  2023-04-15T20:14+0000
  Description
  The UTC timestamp when the schedule is updated.
  Format
  date-time
- created_atstring<date-time>required
  Example
  2023-04-15T20:14+0000
  Description
  The UTC timestamp when the schedule is created.
  Format
  date-time
- updated_bystringrequired
  Description
  The user who updated the schedule.
- created_bystringrequired
  Description
  The user who created the schedule.