Skip to content

Latest commit

 

History

History
111 lines (85 loc) · 7.74 KB

data-types.md

File metadata and controls

111 lines (85 loc) · 7.74 KB
Raw

Типы данных и форматы параметров в REST API

{% note warning "Мы еще обновляем эту страницу" %}

Тут может не хватать некоторых данных — дополним в ближайшее время

{% endnote %}

{% if build == 'dev' %}

{% note alert "TO-DO не выгружается на prod" %}

TO-DO не выгружается на prod

  • статья про часовые пояса и вычисление сдвига от сервера. проверить особенности в задачах и crm и ссылка на нее в блока с примечением
  • статья о работе с файлами со всеми примерами, которые друг от друга отличаются из-за разного api и ссылка на нее в таблице
  • статья про crm.status.list с подробностями о том, какие там значения лежат и как их правильно извлекать. ссылку на статью надо разместить в таблице типов
  • статья про список валюты
  • статья про список контактов
  • статья про список компаний
  • статья про список лидов
  • статья про список компредов
  • статья про работу с местоположениями
  • статья про список дел таймлайна
  • необходимо расписать структуру объекта типа time
  • не хватает описания типов function, callable

{% endnote %}

{% endif %}

Базовые типы данных {#standart-types}

#| || Тип | Описания и значения || || integer | Целое число. Например 10116 || || boolean | Логическое значения. Чаще всего принимает значения 'Y' или 'N'. В некоторых устаревших методах может принимать значения 0 или 1. Внимательно читайте описания к методам! || || double | Число с плавающей точкой. Например, 100.15 || || date | Дата в формате 'YYYY-MM-DD'. Например, '2023-12-28', то есть, 28 февраля 2023 года. || || datetime | Дата и время в формате 'YYYY-MM-DDThh:mm:ss±hh:mm'. Например, '2023-12-28T14:05:48', то есть, 14 часов 5 минут и 48 секунд 28 февраля 2023 года || || string | Однострочное строковое значение. Например, 'Договор поставки' || || text | Многострочное строковое значение, применимое в некоторых специальных полях объектов || || file | Прикрепленный файл. Может принимать числовое значение с уникальным идентификатором файла в системе или значение в виде массива, описывающего ряд параметров файла. Читайте о работе с файлами в соответствующем разделе || || array | Набор элементов простого типа. Например, массив целых чисел [1, 5, 67] или строк ['deal', 'lead', 'quote'] || || object | Структура произвольного уровня вложенности, содержащая элементы разных типов данных. Например,

{
    data: {
        foo: "bar",
        bar: "foo",
        items: [
            1,
            100,
            200,
        ]
    }
}

|| || any | В качестве значения параметра могут выступать различные типы данных || |#

{% note tip "Особенности дат и времени" %}

При работе с полями типов date и datetime обратите внимание, что у каждого пользователя в Битрикс24 может быть указан в настройках собственный часовой пояс. В пользовательском интерфейсе Битрикс24 показывает даты и время, адаптируя их под конкретного пользователя, однако на уровне API все даты и время хранятся с учетом параметров сервера. Читайте подробности в соответствующем материале.

{% endnote %}

Ссылки на объекты и справочники {#standart-objects}

Поля объектов Битрикс24 могут содержать значения, ссылающиеся на другие объекты или на значения из справочников. Технически такие значения, чаще всего, хранятся и указываются в виде целочисленных идентификаторов конкретных объектов или элементов справочников. Но для удобства и подчеркивания таких связей, в документации мы будем использовать специальные типы вроде crm_company или crm_status. Ниже приводятся примеры таких типов со ссылками на методы получения возможных значений.

#| || Тип | Описания и значения || || user | Целочисленный идентификатор пользователя Битрикс24. Например, 1. Получить идентификаторы пользователей можно с помощью метода user.get || |#

Справочники данных различных инструментов Битрикс24:

Объект time {#time}

Объект time присутствует в ответах на все запросы к REST и содержит в себе информацию о времени выполнения запроса.

#| || Название тип | Описание || || start double | Timestamp момента инициализации запроса || || finish double | Timestamp момента завершения выполнения запроса || || duration double | Как долго в миллисекундах выполнялся запрос, то есть разница между finish и start || || date_start string | Строковое представление даты и времени момента инициализации запроса || || date_finish double | Строковое представление даты и времени момента завершения запроса || || operating_reset_at timestamp | Timestamp момента, когда будет сброшен лимит на ресурсы REST API

Читайте подробности в статье лимит на операции || || operating double | Через сколько миллисекунд будет сброшен лимит на ресурсы REST API.

Читайте подробности в статье лимит на операции || |#