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
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["personTypeId"],"filter":{"=domain":"I"},"order":{"personTypeId":"DESC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.businessValuePersonDomain.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type BusinessValuePersonDomain = {
personTypeId: number
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type BusinessValuePersonDomainListResult = {
businessValuePersonDomains: BusinessValuePersonDomain[]
}
// sale.businessValuePersonDomain.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
try {
const response = await $b24.actions.v2.call.make<BusinessValuePersonDomainListResult>({
method: 'sale.businessValuePersonDomain.list',
params: {
select: ['personTypeId'],
filter: { '=domain': 'I' },
order: { personTypeId: 'DESC' },
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.businessValuePersonDomains.length, result.businessValuePersonDomains)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function fetchBusinessValuePersonDomainList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.businessValuePersonDomain.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'sale.businessValuePersonDomain.list',
params: {
select: ['personTypeId'],
filter: { '=domain': 'I' },
order: { personTypeId: 'DESC' },
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.businessValuePersonDomains.length, result.businessValuePersonDomains)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchBusinessValuePersonDomainList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.businessvaluepersondomain.list(
select=[
"personTypeId",
],
filter={
"=domain": "I",
},
order={
"personTypeId": "DESC",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'sale.businessValuePersonDomain.list',
[
'select' => ["personTypeId"],
'filter' => ["=domain" => "I"],
'order' => ["personTypeId" => "DESC"]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'sale.businessValuePersonDomain.list',
{
select: ["personTypeId"],
filter: {"=domain": "I"},
order: {"personTypeId": "DESC"}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'sale.businessValuePersonDomain.list',
[
'select' => ['personTypeId'],
'filter' => ['=domain' => 'I'],
'order' => ['personTypeId' => 'DESC']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.businessValuePersonDomain.list", b24.Params{
"select": []string{"personTypeId"},
"filter": b24.Params{
"=domain": "I",
},
"order": b24.Params{
"personTypeId": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.businessValuePersonDomain.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "businessValuePersonDomains".
raw, ok := b24.Unwrap(res.Result, "businessValuePersonDomains")
if !ok {
return fmt.Errorf("в ответе нет ключа businessValuePersonDomains")
}
var items []struct {
PersonTypeID b24.ID `json:"personTypeId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.PersonTypeID)
}
Ответ
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 |
Другие ошибки (например, фатальные ошибки) |

