crm.item.details.configuration.get
Получить параметры карточки элементов
Описание
Метод crm.item.details.configuration.get возвращает настройки карточки определенного объекта CRM. Может работать как с личными настройками карточки указанного пользователя, так и с общими настройками, заданными для всех пользователей.
Параметры
entityTypeId
integer
обязательный
Идентификатор системного или пользовательского типа объектов CRM
userId
user
необязательный
Идентификатор пользователя, чью конфигурацию вы хотите получить.
Если данный параметр не передан, то будет взят userId пользователя, вызывающего данный метод.
Нужен только при запросе личных настроек
scope
string
необязательный
Область применения настроек. Допустимые значения:
- 'P' — личные настройки
- 'C' — общие настройки
По умолчанию значение равно 'P'
extras
object
необязательный
Дополнительные параметры. Возможные значения и их структура описана ниже
extras
Смарт-процесс
необязательный
categoryId
Сделка
необязательный
dealCategoryId
Лид
необязательный
leadCustomerType
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"userId":1,"scope":"C","extras":{"dealCategoryId":9}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"userId":1,"scope":"C","extras":{"dealCategoryId":9},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.details.configuration.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 SectionElement = {
name: string
optionFlags: string
options?: Record<string, string>
}
type Section = {
name: string
title: string
type: string
elements: SectionElement[]
}
try {
const response = await $b24.actions.v2.call.make<Section[] | null>({
method: 'crm.item.details.configuration.get',
params: {
entityTypeId: 2,
userId: 1,
scope: 'C',
extras: {
dealCategoryId: 9,
},
},
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('Sections count:', result?.length ?? 0, 'first section:', result?.[0]?.name)
}
} 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 getDetailsConfiguration() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.item.details.configuration.get',
params: {
entityTypeId: 2,
userId: 1,
scope: 'C',
extras: {
dealCategoryId: 9,
},
},
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('Sections count:', result?.length ?? 0, 'first section:', result?.[0]?.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDetailsConfiguration)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.details.configuration.get(
entity_type_id=1032,
extras={
"categoryId": 5,
},
).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}")
require_once('crest.php');
$result = CRest::call(
'crm.item.details.configuration.get',
[
'entityTypeId' => 2,
'userId' => 1,
'scope' => "C",
'extras' => [
'dealCategoryId' => 9,
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.details.configuration.get", b24.Params{
"entityTypeId": 2,
"userId": 1,
"scope": "C",
"extras": b24.Params{
"dealCategoryId": 9,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.details.configuration.get: %w", err)
}
var items []struct {
Name string `json:"name"`
Title string `json:"title"`
Type string `json:"type"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Name, it.Title)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"name": "main",
"title": "О сделке",
"type": "section",
"elements": [
{
"name": "TITLE",
"optionFlags": "0"
},
{
"name": "STAGE_ID",
"optionFlags": "0"
},
{
"name": "OPPORTUNITY_WITH_CURRENCY",
"optionFlags": "0"
},
{
"name": "CLOSEDATE",
"optionFlags": "0"
},
{
"name": "CLIENT",
"optionFlags": "1",
"options": {
"defaultCountry": "RU"
}
},
{
"name": "UF_CRM_1686898039656",
"optionFlags": "1"
}
]
},
{
"name": "additional",
"title": "Дополнительно",
"type": "section",
"elements": [
{
"name": "TYPE_ID",
"optionFlags": "0"
},
{
"name": "SOURCE_ID",
"optionFlags": "0"
},
{
"name": "SOURCE_DESCRIPTION",
"optionFlags": "0"
},
{
"name": "BEGINDATE",
"optionFlags": "0"
},
{
"name": "OPENED",
"optionFlags": "0"
},
{
"name": "ASSIGNED_BY_ID",
"optionFlags": "0"
},
{
"name": "OBSERVER",
"optionFlags": "0"
},
{
"name": "COMMENTS",
"optionFlags": "0"
},
{
"name": "UTM",
"optionFlags": "0"
}
]
},
{
"name": "products",
"title": "Товары",
"type": "section",
"elements": [
{
"name": "PRODUCT_ROW_SUMMARY",
"optionFlags": "0"
}
]
},
{
"name": "recurring",
"title": "Регулярная сделка",
"type": "section",
"elements": [
{
"name": "RECURRING",
"optionFlags": "0"
}
]
}
],
"time": {
"start": 1720624891.017344,
"finish": 1720624891.405621,
"duration": 0.3882770538330078,
"processing": 0.02097320556640625,
"date_start": "2024-07-10T17:21:31+02:00",
"date_finish": "2024-07-10T17:21:31+02:00",
"operating": 0
}
}
Возвращаемые данные
result
section[]
Корневой элемент ответа. Содержит конфигурацию разделов детальной карточки элемента. Возвращает null в случае отсутствия конфигурации
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'entityTypeId' is not defined"
}
| Код | Описание | Значение |
|---|---|---|
| — | Parameter 'entityTypeId' is not defined | Не передан обязательный параметр entityTypeId |
| — | The entity type 'entityTypeName' is not supported in current context. |
Метод не поддерживает данный тип сущности |
| — | Access denied. | У пользователя нет административных прав |

