Получить список связей реквизитов crm.requisite.link.list

Scope: crm

Кто может выполнять метод: любой пользователь

Метод возвращает список связей реквизитов по фильтру.

Параметры метода

Название
тип

Описание

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 — номер нужной страницы

Описание полей связи реквизита с объектом CRM

Название
тип

Описание

ENTITY_TYPE_ID
integer

Идентификатор типа объекта, к которому относится связь.

Могут использоваться следующие типы:

  • сделка (значение 2)
  • старый счет (значение 5)
  • предложение (значение 7)
  • новый счет (значение 31)
  • другие динамические объекты (для получения возможных значений смотрите метод crm.type.list).

Идентификаторы типов объектов CRM можно получить с помощью метода crm.enum.ownertype

ENTITY_ID
integer

Идентификатор объекта, к которому относится связь.

Идентификаторы объектов можно получить с помощью следующих методов: crm.deal.list, crm.quote.list, crm.item.list

REQUISITE_ID
integer

Идентификатор реквизита клиента, выбранного для объекта.

Идентификаторы реквизитов можно получить с помощью метода crm.requisite.list

BANK_DETAIL_ID
integer

Идентификатор банковского реквизита клиента, выбранного для объекта.

Идентификаторы банковских реквизитов можно получить с помощью метода crm.requisite.bankdetail.list

MC_REQUISITE_ID
integer

Идентификатор реквизита моей компании, выбранного для объекта.

Идентификаторы реквизитов можно получить с помощью метода crm.requisite.list

MC_BANK_DETAIL_ID
integer

Идентификатор банковского реквизита моей компании, выбранного для объекта.

Идентификаторы банковских реквизитов можно получить с помощью метода crm.requisite.bankdetail.list

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"ENTITY_ID":"ASC"},"filter":{"@ENTITY_TYPE_ID":[1,2,7,31]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.link.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"ENTITY_ID":"ASC"},"filter":{"@ENTITY_TYPE_ID":[1,2,7,31]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.link.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.requisite.link.list',
            {
              order: { "ENTITY_ID": "ASC" },
              filter: { "@ENTITY_TYPE_ID": [1, 2, 7, 31] }    // Лиды, сделки, предложения, счёта.
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('crm.requisite.link.list', {
            order: { "ENTITY_ID": "ASC" },
            filter: { "@ENTITY_TYPE_ID": [1, 2, 7, 31] }    // Лиды, сделки, предложения, счёта.
          }, 'ID');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.requisite.link.list', {
            order: { "ENTITY_ID": "ASC" },
            filter: { "@ENTITY_TYPE_ID": [1, 2, 7, 31] }    // Лиды, сделки, предложения, счёта.
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.link.list',
                    [
                        'order' => ['ENTITY_ID' => 'ASC'],
                        'filter' => ['@ENTITY_TYPE_ID' => [1, 2, 7, 31]],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching requisite links: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.link.list", {
                order: {"ENTITY_ID": "ASC"},
                filter: {"@ENTITY_TYPE_ID": [1, 2, 7, 31]}    // Лиды, сделки, предложения, счёта.
            },
            function (result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                    if (result.more())
                        result.next();
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.link.list',
            [
                'order' => ['ENTITY_ID' => 'ASC'],
                'filter' => ['@ENTITY_TYPE_ID' => [1, 2, 7, 31]]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "ENTITY_TYPE_ID": "7",
                    "ENTITY_ID": "1",
                    "REQUISITE_ID": "0",
                    "BANK_DETAIL_ID": "0",
                    "MC_REQUISITE_ID": "0",
                    "MC_BANK_DETAIL_ID": "0"
                },
                {
                    "ENTITY_TYPE_ID": "7",
                    "ENTITY_ID": "2",
                    "REQUISITE_ID": "0",
                    "BANK_DETAIL_ID": "0",
                    "MC_REQUISITE_ID": "0",
                    "MC_BANK_DETAIL_ID": "0"
                },
                {
                    "ENTITY_TYPE_ID": "7",
                    "ENTITY_ID": "3",
                    "REQUISITE_ID": "0",
                    "BANK_DETAIL_ID": "0",
                    "MC_REQUISITE_ID": "0",
                    "MC_BANK_DETAIL_ID": "0"
                },
                {
                    "ENTITY_TYPE_ID": "7",
                    "ENTITY_ID": "4",
                    "REQUISITE_ID": "7",
                    "BANK_DETAIL_ID": "0",
                    "MC_REQUISITE_ID": "2",
                    "MC_BANK_DETAIL_ID": "2"
                },
                {
                    "ENTITY_TYPE_ID": "7",
                    "ENTITY_ID": "5",
                    "REQUISITE_ID": "0",
                    "BANK_DETAIL_ID": "0",
                    "MC_REQUISITE_ID": "2",
                    "MC_BANK_DETAIL_ID": "2"
                },
                {
                    "ENTITY_TYPE_ID": "7",
                    "ENTITY_ID": "6",
                    "REQUISITE_ID": "0",
                    "BANK_DETAIL_ID": "0",
                    "MC_REQUISITE_ID": "2",
                    "MC_BANK_DETAIL_ID": "2"
                },
                {
                    "ENTITY_TYPE_ID": "2",
                    "ENTITY_ID": "25",
                    "REQUISITE_ID": "38",
                    "BANK_DETAIL_ID": "0",
                    "MC_REQUISITE_ID": "0",
                    "MC_BANK_DETAIL_ID": "0"
                },
                {
                    "ENTITY_TYPE_ID": "31",
                    "ENTITY_ID": "315",
                    "REQUISITE_ID": "60",
                    "BANK_DETAIL_ID": "24",
                    "MC_REQUISITE_ID": "2",
                    "MC_BANK_DETAIL_ID": "2"
                }
            ],
            "total": 8,
            "time": {
                "start": 1718709631.410351,
                "finish": 1718709631.771324,
                "duration": 0.36097288131713867,
                "processing": 0.015230178833007812,
                "date_start": "2024-06-18T13:20:31+02:00",
                "date_finish": "2024-06-18T13:20:31+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
array

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

total
integer

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

time
time

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

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

HTTP-статус: 40x, 50x

{
            "error": 0,
            "error_description": "Access denied."
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Access denied

Недостаточно прав доступа для получения списка связей реквизитов

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить связь реквизита с объектом
Следующая
Удалить связь реквизита с объектом