crm.category.fields
Получить поля воронки
Описание
Метод получает информацию о полях воронок (направлений) объекта CRM.
Параметры
entityTypeId
integer
обязательный
Идентификатор системного или пользовательского типа объектов CRM, для которого нужно получить информацию о полях воронки
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.category.fields
// 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 FieldDescription = {
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
isDynamic: boolean
title: string
upperName: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type CategoryFieldsResult = {
fields: Record<string, FieldDescription>
}
try {
const response = await $b24.actions.v2.call.make<CategoryFieldsResult>({
method: 'crm.category.fields',
params: {
entityTypeId: 2,
},
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 category fields:', Object.keys(result.fields))
}
} 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 getCategoryFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.category.fields',
params: {
entityTypeId: 2,
},
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 category fields:', Object.keys(result.fields))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getCategoryFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.category.fields(
entity_type_id=2,
).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.category.fields',
[
'entityTypeId' => 2,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling crm.category.fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.category.fields",
{
entityTypeId: 2,
},
(result) => {
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
},
);
require_once('crest.php');
$result = CRest::call(
'crm.category.fields',
[
'entityTypeId' => 2
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.category.fields", b24.Params{
"entityTypeId": 2,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.category.fields: %w", err)
}
// Метод заворачивает ответ в объект с ключом "fields".
raw, ok := b24.Unwrap(res.Result, "fields")
if !ok {
return fmt.Errorf("в ответе нет ключа fields")
}
fmt.Printf("%s\n", raw)
Ответ
HTTP-статус: 200
{
"result": {
"fields": {
"id": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID",
"upperName": "ID"
},
"name": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "NAME",
"upperName": "NAME"
},
"sort": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "SORT",
"upperName": "SORT"
},
"entityTypeId": {
"type": "integer",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ENTITY_TYPE_ID",
"upperName": "ENTITY_TYPE_ID"
},
"isDefault": {
"type": "boolean",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "IS_DEFAULT",
"upperName": "IS_DEFAULT"
},
"originId": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ORIGIN_ID",
"upperName": "ORIGIN_ID"
},
"originatorId": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ORIGINATOR_ID",
"upperName": "ORIGINATOR_ID"
}
}
},
"time": {
"start": 1718098629.350263,
"finish": 1718098629.800741,
"duration": 0.45047783851623535,
"processing": 0.02919292449951172,
"date_start": "2024-06-11T11:37:09+02:00",
"date_finish": "2024-06-11T11:37:09+02:00",
"operating": 0
}
}
Возвращаемые данные
result
object
Объект со списком доступных полей в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field_N – идентификатор поля объекта, а value — объект типа crm_rest_field_description
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Смарт-процесс не найден"
}
| Код | Описание | Значение |
|---|---|---|
NOT_FOUND |
Смарт-процесс не найден | Возникает, при некорректных значениях entityTypeId |
ENTITY_TYPE_NOT_SUPPORTED |
Entity type {entityTypeName} is not supported |
Возникает, если сущность CRM не поддерживает воронки |

