editTimeZoneSetting

The editTimeZoneSetting operation handles configuration related to TimeZoneSetting model.

Description

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

The timezone settings configured for this device

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	False	string	A string that represents the name of the object
description	False	string	The timezone settings configured for this device Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
timeZoneObject	False	object	The attributes of a time zone object that defines the time zone that will be used for this device. The object must include at the least the id attribute for the time zone object and the object type, which is always timezoneobject. For example, an object in this attribute would have the following format {"id": "d705bd6c-e468-11e9-aaa4-4de8fd672743","type": "timezoneobject"} Allowed types are: [TimeZoneObject]
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 'editTimeZoneSetting' operation
  ftd_configuration:
    operation: "editTimeZoneSetting"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        timeZoneObject: "{{ time_zone_object }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"