crm.requisite.preset.list
Получить список шаблонов реквизитов по фильтру
Описание
Метод возвращает список шаблонов реквизитов по фильтру.
Параметры
select
array
необязательный
Массив со списком полей, которые необходимо выбрать (смотрите поля шаблона).
Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля шаблонов
filter
object
необязательный
Объект для фильтрации выбранных шаблонов в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям шаблона.
Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно
order
object
необязательный
Объект для сортировки выбранных шаблонов в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям шаблона.
Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Описание полей шаблона реквизитов
ID
integer
необязательный
Идентификатор шаблона. Создается автоматически и уникален в рамках Битрикс24
ENTITY_TYPE_ID
integer
необязательный
Идентификатор типа родительского объекта.
Идентификаторы типов объектов CRM отдает метод crm.enum.ownertype
COUNTRY_ID
integer
необязательный
Идентификатор страны, которой соответствует набор полей шаблона реквизитов (для получения доступных значений смотрите метод crm.requisite.preset.countries)
DATE_CREATE
datetime
необязательный
Дата создания
DATE_MODIFY
datetime
необязательный
Дата изменения. Содержит пустую строку, если шаблон не менялся после создания
CREATED_BY_ID
user
необязательный
Идентификатор пользователя, создавшего шаблон
MODIFY_BY_ID
user
необязательный
Идентификатор пользователя, изменившего шаблон
NAME
string
необязательный
Название шаблона
XML_ID
string
необязательный
Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.
Назначение поля может меняться конечным разработчиком.
Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями.
В CRM зарезервированы значения вида #CRM_REQUISITE_PRESET_DEF_... для идентификации шаблонов, которые используются по умолчанию. Не следует использовать эти идентификаторы для своих целей, так как это может привести к нарушению логики
ACTIVE
char
необязательный
Признак активности. Используются значения Y или N. Определяет доступность шаблона в списке выбора при добавлении реквизитов
SORT
integer
необязательный
Сортировка
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"ASC"},"filter":{"COUNTRY_ID":"1"},"select":["ID","NAME"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"ASC"},"filter":{"COUNTRY_ID":"1"},"select":["ID","NAME"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.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
// Shape of each PresetItem returned in result[]
type PresetItem = {
ID: string
NAME: string
}
try {
// crm.requisite.preset.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<PresetItem[]>({
method: 'crm.requisite.preset.list',
params: {
order: { ID: 'ASC' },
filter: { COUNTRY_ID: '1' },
select: ['ID', 'NAME'],
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('Preset count on this page:', result.length, result)
}
} 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 fetchRequisitePresets() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.requisite.preset.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: 'crm.requisite.preset.list',
params: {
order: { ID: 'ASC' },
filter: { COUNTRY_ID: '1' },
select: ['ID', 'NAME'],
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('Preset count on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchRequisitePresets)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.list(
order={
"ID": "ASC",
},
filter={
"COUNTRY_ID": "1",
},
select=[
"ID",
"NAME",
],
start=0,
).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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.list(
order={
"ID": "ASC",
},
filter={
"COUNTRY_ID": "1",
},
select=[
"ID",
"NAME",
],
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.list(
filter={
"COUNTRY_ID": "1",
},
select=[
"ID",
"NAME",
],
order={
"ID": "DESC",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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(
'crm.requisite.preset.list',
[
'order' => ['ID' => 'ASC'],
'filter' => ['COUNTRY_ID' => '1'],
'select' => ['ID', 'NAME'],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
if ($result->more()) {
$result->next();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching requisite presets: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.preset.list",
{
order: { "ID": "ASC" },
filter: { "COUNTRY_ID": "1"},
select: [ "ID", "NAME"]
},
function(result)
{
if(result.error())
console.error(result.error());
else
{
console.dir(result.data());
if(result.more())
result.next();
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.preset.list',
[
'order' => ['ID' => 'ASC'],
'filter' => ['COUNTRY_ID' => '1'],
'select' => ['ID', 'NAME']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.requisite.preset.list", b24.Params{
"order": b24.Params{
"ID": "ASC",
},
"filter": b24.Params{
"COUNTRY_ID": "1",
},
"select": []string{"ID", "NAME"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.requisite.preset.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"ID": "1",
"NAME": "Организация"
},
{
"ID": "2",
"NAME": "ИП"
},
{
"ID": "3",
"NAME": "Физ. лицо"
},
{
"ID": "4",
"NAME": "Организация (доп.)"
}
],
"total": 4,
"time": {
"start": 1716564019.674636,
"finish": 1716564020.067474,
"duration": 0.3928380012512207,
"processing": 0.02863287925720215,
"date_start": "2024-05-24T17:20:19+02:00",
"date_finish": "2024-05-24T17:20:20+02:00",
"operating": 0
}
}
Возвращаемые данные
result
array
Массив объектов с информацией о выбранных шаблонах. Каждый элемент содержит выбранные поля шаблона
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
{
"error":0,
"error_description":"Access denied."
}
| Код | Описание | Значение |
|---|---|---|
Access denied |
Недостаточно прав доступа для получения списка шаблонов |

