метод REST scope: sale

sale.businessValuePersonDomain.list

Получить список соответствий физическому или юридическому лицу

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

Описание

Метод sale.businessValuePersonDomain.list получает список соответствий физическому или юридическому лицу.

Параметры

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

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

Если не передан или передан пустой массив, то будут выбраны все доступные поля соответствия физическому или юридическому лицу.

Возможные значения элементов массива:
- personTypeId
- domain

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

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

Возможные значения для field:
- personTypeId
- domain

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

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

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

Возможные значения для field:
- personTypeId
- domain

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

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

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

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

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

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

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

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

-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["personTypeId"],"filter":{"=domain":"I"},"order":{"personTypeId":"DESC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.businessValuePersonDomain.list

Ответ

HTTP-статус: 200

{
    "result": {
        "businessValuePersonDomains": [
            {
                "personTypeId": 3
            },
            {
                "personTypeId": 2
            }
        ]
    },
    "total": 2,
    "time": {
        "start": 1712326352.63409,
        "finish": 1712326352.8319,
        "duration": 0.197818040847778,
        "processing": 0.00833678245544434,
        "date_start": "2024-04-05T16:12:32+02:00",
        "date_finish": "2024-04-05T16:12:32+02:00",
        "operating": 0
    }
}

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

result object

Корневой элемент ответа

businessValuePersonDomains sale_business_value_person_domain[]

Массив объектов с информацией о выбранных соответствиях

total integer

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

time time

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

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

HTTP-статус: 400

{
    "error":200040300010,
    "error_description":"Access Denied"
}
Код Описание Значение
200040300010 Нет доступа к чтению
0 Другие ошибки (например, фатальные ошибки)

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

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