Получить поля коннектора biconnector.connector.fields

Scope: biconnector

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

Метод biconnector.connector.fields возвращает описание полей коннектора.
Таблицу с описанием стандартных полей можно найти в статье Коннектор: обзор методов.

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

Без параметров.

Примеры кода

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

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{}' \
             https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.connector.fields
        
curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{"auth":"**put_access_token_here**"}' \
             https://**put_your_bitrix24_address**/rest/biconnector.connector.fields
        
try
        {
        	const response = await $b24.callMethod(
        		'biconnector.connector.fields',
        		{}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'biconnector.connector.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling biconnector.connector.fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'biconnector.connector.fields',
            {},
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'biconnector.connector.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
          "result": {
            "fields": [
              {
                "title": "id",
                "type": "integer",
                "isRequired": true,
                "isReadOnly": true,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "title",
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "logo",
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "description",
                "type": "string",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "sort",
                "type": "integer",
                "isRequired": false,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "urlCheck",
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "urlData",
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "urlTableList",
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "urlTableDescription",
                "type": "string",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": false
              },
              {
                "title": "settings",
                "type": "array",
                "isRequired": true,
                "isReadOnly": false,
                "isImmutable": false,
                "isMultiple": true
              },
              {
                "title": "dateCreate",
                "type": "datetime",
                "isRequired": true,
                "isReadOnly": true,
                "isImmutable": false,
                "isMultiple": false
              }
            ]
          },
          "time": {
            "start": 1740671757.058651,
            "finish": 1740671757.179896,
            "duration": 0.12124514579772949,
            "processing": 5.507469177246094e-5,
            "date_start": "2025-02-27T15:55:57+00:00",
            "date_finish": "2025-02-27T15:55:57+00:00"
          }
        }

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

Название
тип

Описание

result
object

Объект в формате:

{
            field_1: value_1,
            field_2: value_2,
            ...
            field_n: value_n,
        }

где:

time
time

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

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

Метод не возвращает ошибки.

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

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

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

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

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