crm.requisite.preset.field.availabletoadd
Получить поля, доступные для добавления в шаблон реквизитов
Описание
Метод возвращает поля, доступные для добавления в указанный шаблон реквизитов.
Параметры
preset
object
обязательный
Объект, содержащий значение идентификатора шаблона, для которого нужно получить список доступных для добавления настраиваемых полей.
Идентификаторы шаблонов можно получить с помощью метода crm.requisite.preset.list.
Поля с префиксом UF_ в ответе являются пользовательскими (смотрите методы для работы с пользовательскими полями реквизитов)
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.availabletoadd
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.availabletoadd
// 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
try {
const response = await $b24.actions.v2.call.make<string[]>({
method: 'crm.requisite.preset.field.availabletoadd',
params: {
preset: {
ID: 27,
},
},
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('Available fields:', result, 'Count:', result.length)
}
} 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 getAvailablePresetFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.preset.field.availabletoadd',
params: {
preset: {
ID: 27,
},
},
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('Available fields:', result, 'Count:', result.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getAvailablePresetFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.field.availabletoadd(
preset={
"ID": 27,
},
).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(
'crm.requisite.preset.field.availabletoadd',
[
'preset' => [
'ID' => 27
]
]
);
$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 checking available fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.preset.field.availabletoadd",
{
preset:
{
"ID": 27
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.preset.field.availabletoadd',
[
'preset' => ['ID' => 27]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.requisite.preset.field.availabletoadd", b24.Params{
"preset": b24.Params{
"ID": 27,
},
})
if err != nil {
return fmt.Errorf("crm.requisite.preset.field.availabletoadd: %w", err)
}
var items []string
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("получено:", len(items))
Ответ
HTTP-статус: 200
{
"result": [
"RQ_FIRST_NAME",
"RQ_LAST_NAME",
"RQ_SECOND_NAME",
"RQ_COMPANY_NAME",
"RQ_COMPANY_FULL_NAME",
"RQ_COMPANY_REG_DATE",
"RQ_DIRECTOR",
"RQ_ACCOUNTANT",
"RQ_ADDR",
"RQ_CONTACT",
"RQ_EMAIL",
"RQ_PHONE",
"RQ_FAX",
"RQ_IDENT_DOC",
"RQ_IDENT_DOC_SER",
"RQ_IDENT_DOC_NUM",
"RQ_IDENT_DOC_DATE",
"RQ_IDENT_DOC_ISSUED_BY",
"RQ_IDENT_DOC_DEP_CODE",
"RQ_INN",
"RQ_KPP",
"RQ_IFNS",
"RQ_OGRN",
"RQ_OGRNIP",
"RQ_OKPO",
"RQ_OKTMO",
"RQ_OKVED",
"RQ_ST_CERT_SER",
"RQ_ST_CERT_NUM",
"RQ_ST_CERT_DATE",
"RQ_SIGNATURE",
"RQ_STAMP",
"UF_CRM_1707997209",
"UF_CRM_1707997236",
"UF_CRM_1707997253",
"UF_CRM_1708012333"
]
}
Возвращаемые данные
result
array
Массив с названиями полей, которые можно добавить в указанный шаблон реквизитов
time
time
Информация о времени выполнения запроса
Обработка ошибок
{
"error": "",
"error_description": "Шаблон не найден."
}
| Код | Описание | Значение |
|---|---|---|
Шаблон не найден |
Не найден шаблон, для которого нужно получить список полей, доступных для добавления |

