Get Time Profile Entity
Returns Time Profile Entity
Path Parameters
- timeprofile-uid integer required
Possible values:
>= 1Unique Id for time profile
 
- 200
 - 400
 - 401
 - 403
 
OK
- application/json
 
- Schema
 - Example (from schema)
 - One day
 - Daily
 - Daily until date
 - Weekly
 - Every two weeks
 - Monthly
 - Yearly
 - First day of the month
 - Work week
 
Schema
- name string
Timeprofile name
 time_options object
This model represents Timeprofile options
is_all_day booleanIs all day enabled
date_from int64Unix Timestamp Date
date_to int64Unix Timestamp Date
repeat_options object
The model describes repeat option for
timerange in Timeprofilerepeat_enable booleanIf repeat enabled
repeat_format object
The model describes repeat format in Timeprofile
repeat_type stringPossible values: [
day,week,twoWeeks,month,year,custom]Repeat type
repeat_end object
datekey required ifdateformat was chosenformat stringPossible values: [
never,date]Repeat end type
date int64Unix Timestamp Date
repeat_custom object
Only for
customrepeat typerepeat_point_type stringPossible values: [
day,week,month,year]Repeat point type
repeat_looper integerPossible 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[]Possible 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
identifiers object
Model used to providing array of UIDs of various enumerated entities are stored in the panel, such as apartments, identifiers, forward, and similar with
countparamuid_items integer[]Possible values:
>= -1Array of UID for entities references
link_ids uuid[]Array of LinkIDs for entities references
count integerThe number of values in the array
{
  "name": "Work week",
  "time_options": {
    "is_all_day": true,
    "date_from": 1540819272,
    "date_to": 1540819272
  },
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_type": "day",
      "repeat_end": {
        "format": "date",
        "date": 1540819272
      },
      "repeat_custom": {
        "repeat_point_type": "week",
        "repeat_looper": 5,
        "repeat_options": [
          "MON",
          "TUE",
          "WED",
          "THU",
          "FRI"
        ]
      }
    }
  },
  "identifiers": {
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b1",
      "91c615e3-1040-4815-8ecb-039a18b756b2",
      "91c615e3-1040-4815-8ecb-039a18b756b3",
      "91c615e3-1040-4815-8ecb-039a18b756b4"
    ],
    "count": 4
  }
}
{
  "name": "One day",
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "repeat_options": {
    "repeat_enable": false
  },
  "time_options": {
    "is_all_day": true,
    "date_to": 1601920800,
    "date_from": 1601884800
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
{
  "name": "Daily infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "day"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
{
  "name": "Work Week",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "date": 1606780800,
        "format": "date"
      },
      "repeat_type": "day"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
{
  "name": "Weekly infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "week"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
{
  "name": "Every two weeks infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "twoWeeks"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
{
  "name": "Monthly infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "month"
    }
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
{
  "name": "Yearly infinitely",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "year"
    }
  },
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
{
  "name": "First day of the month",
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_custom": {
        "repeat_looper": 1,
        "repeat_options": {
          "range": [
            1
          ],
          "format": "dayNumbers"
        },
        "repeat_point_type": "month"
      },
      "repeat_end": {
        "format": "never"
      },
      "repeat_type": "custom"
    }
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "time_options": {
    "is_all_day": false,
    "date_to": 1601575200,
    "date_from": 1601539200
  },
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
{
  "name": "Work Week",
  "time_options": {
    "is_all_day": false,
    "date_to": 1601920800,
    "date_from": 1601884800
  },
  "repeat_options": {
    "repeat_enable": true,
    "repeat_format": {
      "repeat_custom": {
        "repeat_looper": 1,
        "repeat_options": [
          "WED",
          "FRI",
          "MON",
          "TUE",
          "THU"
        ],
        "repeat_point_type": "week"
      },
      "repeat_end": {
        "date": 1609372800,
        "format": "date"
      },
      "repeat_type": "custom"
    }
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "identifiers": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "link_ids": [
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5",
      "91c615e3-1040-4815-8ecb-039a18b756b5"
    ]
  }
}
Wrong Time Profile Uid
- application/json
 
- Schema
 - Example (from schema)
 - Wrong time profile uid
 
Schema
- error string
Error message
 
{
  "error": "Wrong JSON body"
}
{
  "error": "Wrong Time Profile Uid"
}
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"
}