Получить поля и настройки свойства заказа для определенного типа свойств sale.property.getfieldsbytype

Scope: sale

Кто может выполнять метод: администратор

Метод получает доступные поля свойств заказа по типу свойств.

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

Обязательные параметры отмечены *

Название
тип

Описание

type*
string

Тип свойства заказа
Возможные значения:

  • STRING
  • Y/N
  • NUMBER
  • ENUM
  • FILE
  • DATE
  • LOCATION
  • ADDRESS

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"type":"NUMBER"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.property.getfieldsbytype
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"type":"NUMBER","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.property.getfieldsbytype
        
try
        {
        	const response = await $b24.callMethod(
        		"sale.property.getfieldsbytype", {
        			"type": "NUMBER",
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.property.getfieldsbytype',
                    [
                        'type' => 'NUMBER',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting fields by type: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.property.getfieldsbytype", {
                "type": "NUMBER",
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.property.getfieldsbytype',
            [
                'type' => 'NUMBER'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Ответ в случае успеха

HTTP-статус: 200

{
           "result":{
              "property":{
                 "active":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"char"
                 },
                 "code":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"string"
                 },
                 "defaultValue":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"string"
                 },
                 "description":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"string"
                 },
                 "id":{
                    "isImmutable":false,
                    "isReadOnly":true,
                    "isRequired":false,
                    "type":"integer"
                 },
                 "isFiltered":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"char"
                 },
                 "multiple":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"char"
                 },
                 "name":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":true,
                    "type":"string"
                 },
                 "personTypeId":{
                    "isImmutable":true,
                    "isReadOnly":false,
                    "isRequired":true,
                    "type":"integer"
                 },
                 "propsGroupId":{
                    "isImmutable":true,
                    "isReadOnly":false,
                    "isRequired":true,
                    "type":"integer"
                 },
                 "required":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"char"
                 },
                 "settings":{
                    "fields":{
                       "max":{
                          "isImmutable":false,
                          "isReadOnly":false,
                          "isRequired":false,
                          "type":"integer"
                       },
                       "min":{
                          "isImmutable":false,
                          "isReadOnly":false,
                          "isRequired":false,
                          "type":"integer"
                       },
                       "step":{
                          "isImmutable":false,
                          "isReadOnly":false,
                          "isRequired":false,
                          "type":"integer"
                       }
                    },
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"datatype"
                 },
                 "sort":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"integer"
                 },
                 "type":{
                    "isImmutable":true,
                    "isReadOnly":false,
                    "isRequired":true,
                    "type":"string"
                 },
                 "userProps":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"char"
                 },
                 "util":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"char"
                 },
                 "xmlId":{
                    "isImmutable":false,
                    "isReadOnly":false,
                    "isRequired":false,
                    "type":"string"
                 }
              }
           },
           "time":{
              "start":1712325081.703631,
              "finish":1712325082.067712,
              "duration":0.36408114433288574,
              "processing":0.023890972137451172,
              "date_start":"2024-04-05T16:51:21+03:00",
              "date_finish":"2024-04-05T16:51:22+03:00"
           }
        }

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

HTTP-статус: 400

{
           "error":0,
           "error_description":"error"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

200040300010

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

0

Другие ошибки (например, фатальные ошибки)

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

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

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

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