Получить структуру события календаря
Возвращает структуру полей события календаря
Функция ПолучитьСтруктуруСобытияКалендаря(Знач Пустая = Ложь) Экспорт
Параметр | CLI опция | Тип | Обяз. | Назначение |
---|---|---|---|---|
Пустая | --empty | Булево | ✖ | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей |
Возвращаемое значение: Структура Из КлючИЗначение - Структура полей
Пример использования для 1С:Предприятие/OneScript
Результат = OPI_Bitrix24.ПолучитьСтруктуруСобытияКалендаря();
- Bash
- CMD/Bat
oint bitrix24 ПолучитьСтруктуруСобытияКалендаря \
--empty true
oint bitrix24 ПолучитьСтруктуруСобытияКалендаря ^
--empty true
Результат
{
"type": "<тип календаря: user, group, company_calendar>",
"ownerId": "<идентификатор владельца календаря>",
"from": "<дата и время начала события (строкой)>",
"to": "<дата окончания события (строкой)>",
"from_ts": "<дата и время в формате timestamp (вместо from)>",
"to_ts": "<дата и время в формате timestamp (вместо to)>",
"section": "<идентификатор календаря>",
"name": "<название события>",
"skip_time": "<передать значение даты без времени в параметрах from и to: Y,N>",
"timezone_from": "<часов ой пояс начала (по умолчанию - ч.п. пользователя>",
"timezone_to": "<часовой пояс окончания (по умолчанию - ч.п. пользователя>",
"description": "<описание события>",
"color": "<цвет фона события. Cимвол # - в формате unicode как %23>",
"text_color": "<цвет текста события. Cимвол # - в формате unicode как %23>",
"accessibility": "<доступность на время события: busy, absent, quest, free>",
"importance": "<важность: high, normal, low>",
"private_event": "<частное событие: Y,N>",
"rrule": {
"FREQ": "<частота повторения: DAILY, WEEKLY, MONTHLY, YEARLY>",
"COUNT": "<количество повторений>",
"INTERVAL": "<интервал между повторениями>",
"BYDAY": [
"<дни недели: SU, MO, TU, WE, TH, FR, SA>"
],
"UNTIL": "<дата окончания повторений>"
},
"is_meeting": "<признак встречи с участниками: Y,N>",
"location": "<место проведения>",
"remind": [
{
"type": "<временной тип: min, hour, day>",
"count": "<числовое значение временного промежутка>"
}
],
"attendees": "<массив идентификаторов участников события. Если is_meeting = Y>",
"host": "<идентификатор организатора события. Если is_meeting = Y>",
"meeting": {
"notify": "<флаг оповещения о подтверждении или отказе участников>",
"reinvite": "<флаг запроса повторного подтверждения участия при редактировании события>",
"allow_invite": "<флаг разрешения участникам приглашать других в событие>",
"hide_guests": "<флаг скрытия списка участников>"
}
}