Get Time Range - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Time Range","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 time range associated with the specified ID.**","operationId":"getTimeRange","parameters":[{"description":"Unique identifier of the time range.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"Object representing a time range object.","properties":{"description":{"description":"User provided resource description.","type":"string"},"effectiveEndDateTime":{"description":"Represents the absolute date and time (in ISO 8601 format) at which the time range object stops being effective. If not specified, value is considered, 'never ends'.","type":"string"},"effectiveStartDateTime":{"description":"Represents the absolute date and time (in ISO 8601 format) at which the time range object starts being effective. If not specified, value is considered, 'starts now'.","type":"string"},"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"},"recurrenceList":{"description":"Represents the list of recurring intervals during which the time range is effective. These intervals are valid only between effectiveStartDateTime and effectiveEndDateTime.","items":{"type":"object","description":"Object fragment that represents a recurrence interval. A recurrence interval specifies a duration that repeats on a weekly basis, during which the time range is effective. If recurrence interval is of type RANGE, the fragment represents a continuous duration of time that repeats every week. If recurrence interval is of type DAILY_INTERVAL, the fragment represents a period of time that repeats on selected days of week.","properties":{"dailyEndTime":{"description":"Represents the time (in ISO 8601 format) at which the time range stops being effective on selected days. This field must be used if recurrenceType is specified as DAILY_INTERVAL.","type":"string"},"dailyStartTime":{"description":"Represents the time (in ISO 8601 format) at which the time range starts being effective on selected days. This field must be used if recurrenceType is specified as DAILY_INTERVAL.","type":"string"},"days":{"description":"Represents the days of week on which the time range is effective. This field must be used if recurrenceType is specified as DAILY_INTERVAL.","items":{"enum":["MON","TUE","WED","THU","FRI","SAT","SUN"],"type":"string"},"type":"array"},"rangeEndDay":{"description":"Represents the time (in ISO 8601 format) at which the time range stops being effective. This field must be used if recurrenceType is specified as RANGE.","enum":["MON","TUE","WED","THU","FRI","SAT","SUN"],"type":"string"},"rangeEndTime":{"description":"Represents the day of week at which the time range stops being effective. This field must be used if recurrenceType is specified as RANGE.","type":"string"},"rangeStartDay":{"description":"Represents the day of week at which the time range starts being effective. This field must be used if recurrenceType is specified as RANGE.","enum":["MON","TUE","WED","THU","FRI","SAT","SUN"],"type":"string"},"rangeStartTime":{"description":"Represents the time (in ISO 8601 format) at which the time range starts being effective. This field must be used if recurrenceType is specified as RANGE.","type":"string"},"recurrenceType":{"description":"Type of the recurrence interval. This value can be either DAILY_INTERVAL or RANGE.","enum":["DAILY_INTERVAL","RANGE"],"type":"string"}},"required":["dailyEndTime","dailyStartTime","days","rangeEndDay","rangeEndTime","rangeStartDay","rangeStartTime","recurrenceType"],"$$ref":"#/components/schemas/IRecurrence"},"type":"array"},"type":{"description":"Type of the response object. This value is always TimeRange.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"required":["name"],"$$ref":"#/components/schemas/TimeRange"}}},"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":"getTimeRange","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/timeranges/{objectId}"}}