метод REST scope: crm

crm.requisite.preset.list

Получить список шаблонов реквизитов по фильтру

Кто может выполнять: пользователь с правом на чтение контактов и компаний

Описание

Метод возвращает список шаблонов реквизитов по фильтру.

Параметры

select array необязательный

Массив со списком полей, которые необходимо выбрать (смотрите поля шаблона).

Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля шаблонов

filter object необязательный

Объект для фильтрации выбранных шаблонов в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям шаблона.

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно

order object необязательный

Объект для сортировки выбранных шаблонов в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям шаблона.

Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания

start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Описание полей шаблона реквизитов

ID integer необязательный

Идентификатор шаблона. Создается автоматически и уникален в рамках Битрикс24

ENTITY_TYPE_ID integer необязательный

Идентификатор типа родительского объекта.

Идентификаторы типов объектов CRM отдает метод crm.enum.ownertype

COUNTRY_ID integer необязательный

Идентификатор страны, которой соответствует набор полей шаблона реквизитов (для получения доступных значений смотрите метод crm.requisite.preset.countries)

DATE_CREATE datetime необязательный

Дата создания

DATE_MODIFY datetime необязательный

Дата изменения. Содержит пустую строку, если шаблон не менялся после создания

CREATED_BY_ID user необязательный

Идентификатор пользователя, создавшего шаблон

MODIFY_BY_ID user необязательный

Идентификатор пользователя, изменившего шаблон

NAME string необязательный

Название шаблона

XML_ID string необязательный

Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.

Назначение поля может меняться конечным разработчиком.

Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями.

В CRM зарезервированы значения вида #CRM_REQUISITE_PRESET_DEF_... для идентификации шаблонов, которые используются по умолчанию. Не следует использовать эти идентификаторы для своих целей, так как это может привести к нарушению логики

ACTIVE char необязательный

Признак активности. Используются значения Y или N. Определяет доступность шаблона в списке выбора при добавлении реквизитов

SORT integer необязательный

Сортировка

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"ASC"},"filter":{"COUNTRY_ID":"1"},"select":["ID","NAME"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.list

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "1",
            "NAME": "Организация"
        },
        {
            "ID": "2",
            "NAME": "ИП"
        },
        {
            "ID": "3",
            "NAME": "Физ. лицо"
        },
        {
            "ID": "4",
            "NAME": "Организация (доп.)"
        }
    ],
    "total": 4,
    "time": {
        "start": 1716564019.674636,
        "finish": 1716564020.067474,
        "duration": 0.3928380012512207,
        "processing": 0.02863287925720215,
        "date_start": "2024-05-24T17:20:19+02:00",
        "date_finish": "2024-05-24T17:20:20+02:00",
        "operating": 0
    }
}

Возвращаемые данные

result array

Массив объектов с информацией о выбранных шаблонах. Каждый элемент содержит выбранные поля шаблона

total integer

Общее количество найденных записей

time time

Информация о времени выполнения запроса

Обработка ошибок

{
    "error":0,
    "error_description":"Access denied."
}
Код Описание Значение
Access denied Недостаточно прав доступа для получения списка шаблонов

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.