Returns Time Profile Entity

Returns Time Profile Entity

Path Parameters

• timeProfileUid integer required

  Possible values: >= 1

  Unique Id for time profile

Responses

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• time_options object

  is_all_day boolean

  date_from int64

  Unix Timestamp Date

  date_to int64

  Unix Timestamp Date

• repeat_options object

  only for time range

  repeat_enable boolean

  repeat_format object

  repeat_type string

  Possible values: [day, week, twoWeeks, month, year, custom]

  repeat_end object

  date key required if date format was choosen

  format string

  Possible values: [never, date]

  date int64

  Unix Timestamp Date

  repeat_custom object

  only for custom repeat type

  repeat_point_type string

  Possible values: [day, week, month, year]

  repeat_looper integer

  Possible values: >= 1 and <= 1000

  repeat_options object

  oneOf

  • MOD1
  • MOD2
  • MOD3

  ---

  string

  Possible values: [MON, TUE, WED, THU, FRI, SAT, SUN]

  format string

  Possible values: [dayNumbers, parameterizedDay]

  range object

  oneOf

  • MOD1
  • MOD2

  ---

  integer

  Possible values: >= 1 and <= 31

  week_order string

  Possible values: [first, second, third, fourth, fifth, last]

  day_type string

  Possible values: [MON, TUE, WED, THU, FRI, SAT, SUN, WEEK_DAY, DAY_OFF]

  months integer[]

  Possible values: >= 1, <= 12

  range object

  week_order string

  Possible values: [first, second, third, fourth, fifth, last]

  day_type string

  Possible values: [MON, TUE, WED, THU, FRI, SAT, SUN, WEEK_DAY, DAY_OFF]

• 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

  count integer

  The number of values in the array

  uid_items integer[]

  Possible values: >= -1

  Array of UID for entities referenses.

• link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

{
  "name": "Worker",
  "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": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5"
}

Wrong Time Profile Uid

Log In

Administrator rights required

Loading...