Skip to content

Latest commit

 

History

History
154 lines (124 loc) · 3.78 KB

crm-contact-company-fields.md

File metadata and controls

154 lines (124 loc) · 3.78 KB

Получить поля для связи контакт-компания crm.contact.company.fields

Scope: crm

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

Метод crm.contact.company.fields возвращает описание полей для связи контакт-компания.

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

Примеры кода

{% include Сноска о примерах %}

Получить список полей для связи контакт-компания

{% list tabs %}

  • cURL (Webhook)

    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_webbhook_here**/crm.contact.company.fields
  • cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.contact.company.fields
  • JS

    BX24.callMethod(
        'crm.contact.company.fields',
        {},
        (result) => {
            result.error()
                ? console.error(result.error())
                : console.info(result.data())
            ;
        },
    );
  • PHP

    require_once('crest.php');
    
    $result = CRest::call(
        'crm.contact.company.fields',
        []
    );
    
    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

{% endlist %}

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

HTTP-статус: 200

{
    "result": {
        "SORT": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Сортировка"
        },
        "IS_PRIMARY": {
            "type": "char",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Первичный"
        },
        "COMPANY_ID": {
            "type": "integer",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Компания"
        }
    },
    "time": {
        "start": 1724065480.986461,
        "finish": 1724065481.321185,
        "duration": 0.33472418785095215,
        "processing": 0.01616501808166504,
        "date_start": "2024-08-19T13:04:40+02:00",
        "date_finish": "2024-08-19T13:04:41+02:00"
    }
}

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

#| || Название тип | Описание || || result object | Объект в формате:

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

где:

  • field_n — поле элемента
  • value_n — информация о поле в формате crm_rest_field_description || || time time | Информация о времени выполнения запроса || |#

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

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

{% include системные ошибки %}

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