Description

The addTimeZoneObject operation handles configuration related to TimeZoneObject model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

POST /api/fdm/v6/object/timezoneobjects

Data Parameters

Parameter Required Type Description
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.
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "description": "string",
        "dstDateRange": {
            "endDateTime": "string",
            "offset": 0,
            "startDateTime": "string",
            "type": "daylightsavingdaterange"
        },
        "dstDayRecurrence": {
            "endDayOfWeek": "SUN",
            "endMonth": "JAN",
            "endTime": "string",
            "endWeek": "FIRST",
            "offset": 0,
            "startDayOfWeek": "SUN",
            "startMonth": "JAN",
            "startTime": "string",
            "startWeek": "FIRST",
            "type": "daylightsavingdayrecurrence"
        },
        "id": "string",
        "name": "string",
        "timeZone": "string",
        "timeZoneId": "string",
        "type": "timezoneobject",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/timezoneobjects"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def add_time_zone_object(client, body):
    return client.TimeZoneObjects.addTimeZoneObject(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {'description': 'string',
 'dstDateRange': {'endDateTime': 'string',
                  'offset': 0,
                  'startDateTime': 'string',
                  'type': 'daylightsavingdaterange'},
 'dstDayRecurrence': {'endDayOfWeek': 'SUN',
                      'endMonth': 'JAN',
                      'endTime': 'string',
                      'endWeek': 'FIRST',
                      'offset': 0,
                      'startDayOfWeek': 'SUN',
                      'startMonth': 'JAN',
                      'startTime': 'string',
                      'startWeek': 'FIRST',
                      'type': 'daylightsavingdayrecurrence'},
 'name': 'string',
 'timeZone': 'string',
 'timeZoneId': 'string',
 'type': 'timezoneobject'}

    add_time_zone_object(client, body)