crm.requisite.preset.field.get
Получить настраиваемое поле шаблона реквизитов по id
Описание
Метод возвращает описание настраиваемого поля шаблона реквизитов по идентификатору.
Параметры
id
integer
обязательный
Идентификатор настраиваемого поля.
Идентификаторы настраиваемых полей шаблона реквизитов можно получить с помощью метода crm.requisite.preset.field.list
preset
object
обязательный
Объект, содержащий значение идентификатора шаблона, из которого извлекается информация о настраиваемом поле (например, {"ID": 27}).
Идентификаторы шаблонов можно получить с помощью метода crm.requisite.preset.list
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":1,"preset":{"ID":27}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":1,"preset":{"ID":27},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.get
// 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 the payload returned in result (match the "response handling" section of the page)
type PresetFieldResult = {
ID: number
FIELD_NAME: string
FIELD_TITLE: string
IN_SHORT_LIST: string
SORT: number
}
try {
const response = await $b24.actions.v2.call.make<PresetFieldResult>({
method: 'crm.requisite.preset.field.get',
params: {
ID: 1,
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(result.ID, result.FIELD_NAME, result.FIELD_TITLE, result.SORT)
}
} 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 getPresetField() {
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.get',
params: {
ID: 1,
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(result.ID, result.FIELD_NAME, result.FIELD_TITLE, result.SORT)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getPresetField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.preset.field.get(
bitrix_id=1,
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.get',
[
'ID' => 1,
'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 getting preset field: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.preset.field.get",
{
ID: 1, // Идентификатор настраиваемого поля
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.get',
[
'ID' => 1,
'preset' => ['ID' => 27]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.requisite.preset.field.get", b24.Params{
"id": 1,
"preset": b24.Params{
"ID": 27,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.requisite.preset.field.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
FieldName string `json:"FIELD_NAME"`
FieldTitle string `json:"FIELD_TITLE"`
InShortList string `json:"IN_SHORT_LIST"`
Sort int `json:"SORT"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.FieldName)
Ответ
HTTP-статус: 200
{
"result": {
"ID": 1,
"FIELD_NAME": "RQ_NAME",
"FIELD_TITLE": "TEST",
"IN_SHORT_LIST": "N",
"SORT": 580
},
"time": {
"start": 1716826213.057061,
"finish": 1716826213.541336,
"duration": 0.48427510261535645,
"processing": 0.025674104690551758,
"date_start": "2024-05-27T18:10:13+02:00",
"date_finish": "2024-05-27T18:10:13+02:00",
"operating": 0
}
}
Возвращаемые данные
result
object
Объект, содержащий поля, описывающие настраиваемое поле шаблона реквизитов
time
time
Информация о времени выполнения запроса
Обработка ошибок
{
"error": "",
"error_description": "The PresetField with ID '1' is not found"
}
| Код | Описание | Значение |
|---|---|---|
The PresetField with ID '1' is not found |
Настраиваемое поле шаблона с указанным идентификатором не найдено | |
The Preset with ID '27' is not found |
Шаблон с указанным идентификатором не найден | |
Access denied |
Недостаточно прав доступа для получения настраиваемого поля шаблона |

