Update Time Profile Entity
Update Time Profile Entity
Path Parameters
- timeprofile-uid integer required
Possible values:
>= 1Unique Id for time profile
- application/json
Request Body required
- name string required
Timeprofile name
time_options object required
This model represents Timeprofile options
is_all_day boolean requiredIs all day enabled
date_from int64 requiredUnix Timestamp Date
date_to int64 requiredUnix Timestamp Date
repeat_options object required
The model describes repeat option for
timerange in Timeprofilerepeat_enable boolean requiredIf repeat enabled
repeat_format object
The model describes repeat format in Timeprofile
repeat_type string requiredPossible values: [
day,week,twoWeeks,month,year,custom]Repeat type
repeat_end object required
datekey required ifdateformat was chosenformat string requiredPossible values: [
never,date]Repeat end type
date int64Unix Timestamp Date
repeat_custom object
Only for
customrepeat typerepeat_point_type string requiredPossible values: [
day,week,month,year]Repeat point type
repeat_looper integer requiredPossible values:
>= 1and<= 1000Repeat looper
repeat_options object
Repeat options
oneOf- MOD1
- MOD2
- MOD3
stringPossible values: [
MON,TUE,WED,THU,FRI,SAT,SUN]Week days
format stringPossible values: [
dayNumbers,parameterizedDay]Format in month options
range object
Repeat range
oneOf- MOD1
- MOD2
integerPossible values:
>= 1and<= 31Dey of the month number
week_order stringPossible values: [
first,second,third,fourth,fifth,last]Week order
day_type stringPossible values: [
MON,TUE,WED,THU,FRI,SAT,SUN,WEEK_DAY,DAY_OFF]Day type
months integer[] requiredPossible values:
>= 1,<= 12List of months
range object
Parametrized day options used in complex time rule
week_order stringPossible values: [
first,second,third,fourth,fifth,last]Week order
day_type stringPossible values: [
MON,TUE,WED,THU,FRI,SAT,SUN,WEEK_DAY,DAY_OFF]Day type
- 200
- 400
- 401
- 403
OK
- Wrong Time Profile Uid
- Wrong repeat options
- application/json
- Schema
- Example (from schema)
- Wrong Time Profile Uid
- Wrong date range
- Wrong repeat_type
- Wrong format
- Wrong repeat_point_type
- Wrong repeat_options
- Wrong repeat_looper range
- Wrong Week Options
- Wrong year range
- Wrong Year Options
- Wrong Day Of Month
- Wrong months range
- Wrong day Numbers
Schema
- MOD1
- MOD2
- error string
Error message
- error string
Possible values: [
Wrong repeat_type,Wrong format enum name,Wrong repeat_point_type enum name,Wrong repeat_options enum name,Wrong repeat_looper range,Set in WeekOptions can't be empty,Wrong year range,Set in YearOptions can't be empty,Wrong DayOfMonth range,Wrong months range,Set in dayNumbers can't be empty,Wrong Time Profile Uid]Error message
{
"error": true
}
{
"error": "Wrong Time Profile Uid"
}
{
"error": "Wrong date range: date_from cannot be greater than date_to"
}
{
"error": "Wrong repeat_type"
}
{
"error": "Wrong format enum name"
}
{
"error": "Wrong repeat_point_type enum name"
}
{
"error": "Wrong repeat_options enum name"
}
{
"error": "Wrong repeat_looper range"
}
{
"error": "Set in WeekOptions can't be empty"
}
{
"error": "Wrong year range"
}
{
"error": "Set in YearOptions can't be empty"
}
{
"error": "Wrong DayOfMonth range"
}
{
"error": "Wrong months range"
}
{
"error": "Set in dayNumbers can't be empty"
}
Unauthorized request. Log In
- application/json
- Schema
- Example (from schema)
- Log In
Schema
- error string
Error message
{
"error": "Log In"
}
{
"error": "Log In"
}
Administrator rights required. You are currently logged in with different user account. Log In with administrator rights
- application/json
- Schema
- Example (from schema)
- Admin Rights Required
Schema
- error string
Error message
{
"error": "Administrator rights required"
}
{
"error": "Administrator rights required"
}