Get multiple Time Profile items with link_id
Get multiple Time Profile items with link_id
.
This can be used by 3d-party management system. Link adds to each time profile link_id
.
Query Parameters
- limit integer
Possible values: [
10
,20
,30
,50
]Number of items. Value by default is 10
- page_number integer
Possible values:
>= 1
Page number
- sort_field string
Field name (JSON Key in item entity)
- sort_type string
Possible values: [
asc
,desc
]Default value:
asc
Sort type (asc/desc)
- filter object
Filtering options for TimeProfile
- 200
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Equal ` Work week`
- Since Monday, October 29, 2018 1:21:11 P M (1540819271 timestamp)
- Until Monday, October 29, 2018 1:21:13 P M (1540819273 timestamp)
Schema
list_items object[]
List of TimeProfiles
name stringTimeprofile 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
time
range 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
date
key required ifdate
format was chosenformat stringPossible values: [
never
,date
]Repeat end type
date int64Unix Timestamp Date
repeat_custom object
Only for
custom
repeat typerepeat_point_type stringPossible values: [
day
,week
,month
,year
]Repeat point type
repeat_looper integerPossible values:
>= 1
and<= 1000
Repeat 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:
>= 1
and<= 31
Dey 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
,<= 12
List 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
link_id uuidUnique entity set by the server to bind some parameters with each other. By default return null value
{
"list_items": [
{
"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"
]
}
}
},
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5"
}
]
}
{
"list_items": [
{
"time_profile_uid": 1,
"name": "Work week",
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"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_ids": [
"91c615e3-1040-4815-8ecb-039a18b756b5",
"91c615e3-1040-4815-8ecb-039a18b756b5",
"91c615e3-1040-4815-8ecb-039a18b756b5"
]
}
}
],
"list_option": {
"pagination": {
"total_items": 18,
"items_limit": 10,
"total_pages": 2,
"current_page": 1
},
"filter": {
"filter_field": "name",
"filter_type": "equal",
"filter_format": "string",
"filter_value": "Work week",
"available_filtering": true,
"available_fields": [
"name",
"date_from",
"date_to",
"link_id"
],
"is_filtered": true
},
"sort": {
"asc": true,
"field": "name",
"available_fields": [
"date_to",
"date_from",
"name"
]
}
}
}
{
"list_option": {
"pagination": {
"total_pages": 1,
"items_limit": 10,
"total_items": 1,
"current_page": 1
},
"filter": {
"is_filtered": true,
"available_filtering": true,
"filter_format": "number",
"filter_type": "equal",
"available_fields": [
"date_to",
"date_from",
"name",
"link_id"
],
"filter_field": "date_from",
"filter_value": 1540819271
},
"sort": {
"asc": true,
"field": "name",
"available_fields": [
"date_to",
"date_from",
"name"
]
}
},
"list_items": [
{
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_end": {
"date": 1540819272,
"format": "date"
},
"repeat_type": "day"
}
},
"identifiers": {
"count": 1,
"uid_items": [
1
],
"link_ids": [
"91c615e3-1040-4815-8ecb-039a18b756b5"
]
},
"time_profile_uid": 1,
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"time_options": {
"is_all_day": true,
"date_to": 1540819272,
"date_from": 1540819272
},
"name": "Work week"
}
]
}
{
"list_option": {
"pagination": {
"total_pages": 1,
"items_limit": 10,
"total_items": 1,
"current_page": 1
},
"filter": {
"is_filtered": true,
"available_filtering": true,
"filter_format": "number",
"filter_type": "equal",
"available_fields": [
"date_to",
"date_from",
"name",
"link_id"
],
"filter_field": "date_to",
"filter_value": 1540819273
},
"sort": {
"asc": true,
"field": "name",
"available_fields": [
"date_to",
"date_from",
"name"
]
}
},
"list_items": [
{
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_end": {
"date": 1540819272,
"format": "date"
},
"repeat_type": "day"
}
},
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"identifiers": {
"count": 1,
"uid_items": [
1
],
"link_ids": [
"91c615e3-1040-4815-8ecb-039a18b756b5"
]
},
"time_profile_uid": 1,
"time_options": {
"is_all_day": true,
"date_to": 1540819272,
"date_from": 1540819272
},
"name": "Work week"
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- error string
Error message
{
"error": "Log In"
}
{
"error": "Log In"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
- error string
Error message
{
"error": "Administrator rights required"
}
{
"error": "Administrator rights required"
}