editTimeZoneObject

The editTimeZoneObject operation handles configuration related to TimeZoneObject model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name	True	string	The name of the object.
description	False	string	An optional description of the object. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
timeZoneId	False	string	Mandatory Field. Id from global time zone list api. Represent the timeZone ID Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
timeZone	False	string	Optional Field. Represents the full timezone string consisting of UTC offset and timezone ID. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
dstDateRange	False	object	(Optional). Section that defines DayLightSavingDateRecurrence object. Use this attribute if you want to define daylight saving time based on DATE. Required details to provide are startDateTime, endDateTime and type.
dstDayRecurrence	False	object	(Optional). Section that defines DayLightSavingDayRecurrence object. Use this attribute if you want to define daylight saving time based on DAY. Required details to provide are startMonth,startWeek, startDayOfWeek, startTime, endMonth, endWeek, endDayOfWeek, endTime and type.
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editTimeZoneObject' operation
  ftd_configuration:
    operation: "editTimeZoneObject"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        timeZoneId: "{{ time_zone_id }}"
        timeZone: "{{ time_zone }}"
        dstDateRange: "{{ dst_date_range }}"
        dstDayRecurrence: "{{ dst_day_recurrence }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"