Summary
Get time
Description
Gets the current time with an optional offset, timezone shift, and format string
Route
No Northbound API Available
Roles
admin
engineering
support
apiread
apiwrite
Parameters
DetailsExampleSchema
Name | Type | Required | Description |
---|---|---|---|
timezone | enum | yes | Allowed values are: [ -11:00, -10:00, -09:00, -08:00, -07:00, -06:00, -05:00, -04:00, -03:00, -02:00, -01:00, +00:00, +01:00, +02:00, +03:00, +04:00, +05:00, +06:00, +07:00, +08:00, +09:00, +10:00, +11:00, +12:00 ] - Timezone of to use when getting the current time |
offsetDuration | object | no | Amount of time to offset the current time by |
format | string | no | Moment.js date-time format string. See https://momentjs.com/docs/#/displaying/format/ |
Return
DetailsExampleSchema
Name | Type | Description |
---|---|---|
time | object | An ISO string representation of the current time |