Get All Time Zone Object - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Time Zone Object","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the list of all time zone objects.**","operationId":"getAllTimeZoneObject","parameters":[{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/timezoneobjects ( Get all paginated TimeZoneObject resources with limit=2 )":{"value":{"items":[{"description":" ","id":"timeZoneObjectId1","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId1"},"metadata":{"domain":{"id":"DomainUUID","name":"Domain Name","type":"Domain"},"lastUser":{"name":"api"},"timestamp":0},"name":"TestObj1","overridable":false,"timeZone":"(UTC+05:30) Asia/Calcutta","timeZoneId":"Asia/Calcutta","type":"TimeZoneObject"},{"description":" ","dstDayRecurrence":{"endDayOfWeek":"TUE","endMonth":"FEB","endTime":"11:01","endWeek":"SECOND","offset":20,"startDayOfWeek":"MON","startMonth":"JAN","startTime":"11:00","startWeek":"FIRST"},"id":"timeZoneObjectId2","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/timezoneobjects/timeZoneObjectId2"},"metadata":{"domain":{"id":"DomainUUID","name":"Domain Name","type":"Domain"},"lastUser":{"name":"api"},"timestamp":0},"name":"TestObj2","overridable":false,"timeZone":"(UTC+05:30) Asia/Calcutta","timeZoneId":"Asia/Calcutta","type":"TimeZoneObject"}],"links":{"self":"/fmc_config/v1/domain/DomainUUID/object/timezoneobjects?offset=0&limit=2"},"paging":{"count":0,"limit":2,"next":["/fmc_config/v1/domain/DomainUUID/object/timezoneobjects?offset=0&limit=2"],"offset":0,"pages":1}}},"Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/timezoneobjects?overrideTargetId=target_uuid ( Get all paginated TimeZoneObject objects without offset and limit )":{"value":{"items":[{"id":"objectId","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/timezoneobjects/objectId?overrideTargetId=target_uuid"},"name":"tz01","type":"TimeZoneObject"}],"links":{"self":"/fmc_config/v1/domain/DomainUUID/object/timezoneobjects?overrideTargetId=target_uuid"},"paging":{"count":1,"limit":1,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Object representing a time zone object.","properties":{"description":{"description":"User provided resource description. ","type":"string"},"dstDateRange":{"description":"Object representing the daylight saving configuration by date range. Either dstDateRange or dstDayRecurrence field must be configured to enable daylight saving for the object.","type":"object","properties":{"endDateTime":{"description":"Represents the date and time (in ISO 8601 format) at which the daylight saving with end.","type":"string"},"offset":{"description":"Number (in minutes) representing the offset from specified time zone. Offset value must be between 1-1440.","format":"int32","type":"integer"},"startDateTime":{"description":"Represents the date and time (in ISO 8601 format) at which the daylight saving will start.","type":"string"}},"$$ref":"#/components/schemas/ITimeZoneDateRangeFragment"},"dstDayRecurrence":{"description":"Object representing the daylight saving configuration by day-based recurrence. Either dstDateRange or dstDayRecurrence field must be configured to enable daylight saving.","type":"object","properties":{"endDayOfWeek":{"description":"Day of the week on which the daylight saving will end.","enum":["MON","TUE","WED","THU","FRI","SAT","SUN"],"type":"string"},"endMonth":{"description":"Month of the year on which the daylight saving will end.","enum":["JAN","FEB","MAR","APR","MAY","JUN","JUL","AUG","SEP","OCT","NOV","DEC"],"type":"string"},"endTime":{"description":"Time of the day (in 24-hour HH:mm format) at which the daylight saving will end.","type":"string"},"endWeek":{"description":"An ordinal number, from 1-52, representing the week on which the daylight saving will end.","enum":["FIRST","SECOND","THIRD","FOURTH","LAST"],"type":"string"},"offset":{"description":"Number (in minutes) representing the offset from specified time zone. Offset value must be between 1-1440.","format":"int32","type":"integer"},"startDayOfWeek":{"description":"Day of the week on which the daylight saving will start.","enum":["MON","TUE","WED","THU","FRI","SAT","SUN"],"type":"string"},"startMonth":{"description":"Month of the year on which the daylight saving will start.","enum":["JAN","FEB","MAR","APR","MAY","JUN","JUL","AUG","SEP","OCT","NOV","DEC"],"type":"string"},"startTime":{"description":"Time of the day (in 24-hour HH:mm format) at which the daylight saving will start.","type":"string"},"startWeek":{"description":"An ordinal number, from 1-52, representing the week on which daylight saving will start.","enum":["FIRST","SECOND","THIRD","FOURTH","LAST"],"type":"string"}},"$$ref":"#/components/schemas/ITimeZoneDayRecurrenceFragment"},"id":{"description":"Unique identifier representing response object.","type":"string"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata properties of the response object.","type":"object","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"description":"User assigned resource name.","type":"string"},"overridable":{"description":"Boolean indicating whether object values can be overridden.","type":"boolean"},"overrideTargetId":{"description":"Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain).","type":"string"},"overrides":{"description":"An object override allows you to define an alternate value for an object on a device or domain.","type":"object","properties":{"parent":{"description":"Link to the parent/global resource which is overriden.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"target":{"description":"The device or the domain target on which this override is enabled.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"}},"$$ref":"#/components/schemas/IOverride"},"timeZone":{"description":"Read-only field containing description of the specified global time zone (timeZoneId).","type":"string"},"timeZoneId":{"description":"Unique identifier of the global time zone from the IANA time zone (tz) database.","type":"string"},"type":{"description":"Type of the response object. This value is always TimeZoneObject.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/TimeZoneObject"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/TimeZoneObjectListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Object"],"__originalOperationId":"getAllTimeZoneObject","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/timezoneobjects"}}