Era.Common.DataDefinition.Common.RelativeTimeInterval
Description
Structure to store time intervals, allowing to define intervals like "last week", "MTD", "next month", ...
Properties
Name |
JsonSchemaType |
Description |
durationFrom |
integer |
Start of the time interval. 0 means "now", positive values are in the past, negative values are in the future. ([durationFrom] is earlier than [durationTo]) |
durationTo |
integer |
End of the time interval. 0 means "now", positive values are in the past, negative values are in the future. ([durationFrom] is earlier than [durationTo]) |
roundDuration |
boolean |
If true, the values are rounded to whole time units. E.g. "now" - 1 month rounded is the 1st of this month. If this value is set, [roundDurationFrom] and [roundDurationTo] must not be set. |
roundDurationFrom |
boolean |
If true, the [durationFrom] value is rounded to whole time units. E.g. "now" - 1 month rounded is the 1st of this month. If this value is set, [roundDuration] must not be set. |
roundDurationTo |
boolean |
If true, the [durationTo] value is rounded to whole time units. E.g. "now" - 1 month rounded is the 1st of this month. If this value is set, [roundDuration] must not be set. |
timeUnit |
enum of Era.Common.DataDefinition.Common.RelativeTimeInterval_TimeUnit |
Time unit for the duration. Both, [durationFrom] and [durationTo], have the same time unit. |
timeZone |
reference to Era.Common.DataDefinition.Common.RelativeTimeTimeZone |
|
Dual message (request/response)
No dual message.Referenced in messages
Era.Common.DataDefinition.Common.MultiDataType
JsonSchema
{
"title": "Era.Common.DataDefinition.Common.RelativeTimeInterval",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"required": [
"Era.Common.DataDefinition.Common.RelativeTimeInterval"
],
"properties": {
"Era.Common.DataDefinition.Common.RelativeTimeInterval": {
"$ref": "#/definitions/RelativeTimeInterval"
}
},
"definitions": {
"RelativeTimeInterval": {
"additionalProperties": false,
"required": [
"timeUnit"
],
"type": "object",
"properties": {
"durationFrom": {
"type": "integer"
},
"durationTo": {
"type": "integer"
},
"roundDuration": {
"type": "boolean"
},
"roundDurationFrom": {
"type": "boolean"
},
"roundDurationTo": {
"type": "boolean"
},
"timeUnit": {
"enum": [
1,
2,
3,
4,
5,
6
]
},
"timeZone": {
"$ref": "Era.Common.DataDefinition.Common.RelativeTimeTimeZone#/definitions/RelativeTimeTimeZone"
}
}
}
}
}