Получить пользовательский тип по id crm.type.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь с административным доступом к смарт-процессу, либо пользователь с правом на чтение смарт-процесса
Метод получает информацию о смарт-процессе с идентификатором id.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор смарт-процесса. Можно получить с помощью методов: |
Примеры кода
Получить информацию о смарт-процессе с id = 16.
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":16}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":16,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.type.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type TypeGetResult = {
type: {
id: number
title: string
code: string
createdBy: number
entityTypeId: number
customSectionId: number | null
isCategoriesEnabled: 'Y' | 'N'
isStagesEnabled: 'Y' | 'N'
isBeginCloseDatesEnabled: 'Y' | 'N'
isClientEnabled: 'Y' | 'N'
isUseInUserfieldEnabled: 'Y' | 'N'
isLinkWithProductsEnabled: 'Y' | 'N'
isMycompanyEnabled: 'Y' | 'N'
isDocumentsEnabled: 'Y' | 'N'
isSourceEnabled: 'Y' | 'N'
isObserversEnabled: 'Y' | 'N'
isRecyclebinEnabled: 'Y' | 'N'
isAutomationEnabled: 'Y' | 'N'
isBizProcEnabled: 'Y' | 'N'
isSetOpenPermissions: 'Y' | 'N'
isPaymentsEnabled: 'Y' | 'N'
isCountersEnabled: 'Y' | 'N'
createdTime: ISODate | null
updatedTime: ISODate | null
updatedBy: number
relations: {
parent: { entityTypeId: number; isChildrenListEnabled: 'Y' | 'N'; isPredefined: 'Y' | 'N' }[]
child: { entityTypeId: number; isChildrenListEnabled: 'Y' | 'N'; isPredefined: 'Y' | 'N' }[]
}
linkedUserFields: Record<string, 'Y' | 'N'>
customSections: unknown[]
}
}
try {
const response = await $b24.actions.v2.call.make<TypeGetResult>({
method: 'crm.type.get',
params: {
id: 16,
},
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.type.id, result.type.title, result.type.entityTypeId)
}
} 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 getType() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.type.get',
params: {
id: 16,
},
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.type.id, result.type.title, result.type.entityTypeId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getType)
</script>
try {
$response = $b24Service
->core
->call(
'crm.type.get',
[
'id' => 16,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
return;
}
echo 'Success: ' . print_r($result->data(), true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting CRM type: ' . $e->getMessage();
}
BX24.callMethod(
'crm.type.get',
{
id: 16,
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.type.get',
[
'id' => 16
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"type": {
"id": 16,
"title": "Смарт-процесс",
"code": "",
"createdBy": 1,
"entityTypeId": 2024,
"customSectionId": null,
"isCategoriesEnabled": "Y",
"isStagesEnabled": "Y",
"isBeginCloseDatesEnabled": "Y",
"isClientEnabled": "Y",
"isUseInUserfieldEnabled": "Y",
"isLinkWithProductsEnabled": "Y",
"isMycompanyEnabled": "Y",
"isDocumentsEnabled": "Y",
"isSourceEnabled": "Y",
"isObserversEnabled": "Y",
"isRecyclebinEnabled": "Y",
"isAutomationEnabled": "Y",
"isBizProcEnabled": "Y",
"isSetOpenPermissions": "Y",
"isPaymentsEnabled": "N",
"isCountersEnabled": "N",
"createdTime": "2024-07-08T14:46:54+02:00",
"updatedTime": "2024-07-08T14:46:54+02:00",
"updatedBy": 1,
"relations": {
"parent": [
{
"entityTypeId": 3,
"isChildrenListEnabled": "Y",
"isPredefined": "Y"
},
{
"entityTypeId": 4,
"isChildrenListEnabled": "Y",
"isPredefined": "Y"
},
{
"entityTypeId": 1,
"isChildrenListEnabled": "Y",
"isPredefined": "N"
},
{
"entityTypeId": 2,
"isChildrenListEnabled": "Y",
"isPredefined": "N"
},
{
"entityTypeId": 31,
"isChildrenListEnabled": "Y",
"isPredefined": "N"
}
],
"child": [
{
"entityTypeId": 3,
"isChildrenListEnabled": "Y",
"isPredefined": "N"
},
{
"entityTypeId": 4,
"isChildrenListEnabled": "N",
"isPredefined": "N"
}
]
},
"linkedUserFields": {
"CALENDAR_EVENT|UF_CRM_CAL_EVENT": "Y",
"TASKS_TASK|UF_CRM_TASK": "Y",
"TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N"
},
"customSections": []
}
},
"time": {
"start": 1720442829.865672,
"finish": 1720442830.334845,
"duration": 0.46917295455932617,
"processing": 0.13246917724609375,
"date_start": "2024-07-08T14:47:09+02:00",
"date_finish": "2024-07-08T14:47:10+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержащий объект |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Смарт-процесс не найден"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Действие разрешено только интранет-пользователям |
Возникает, если пользователь не является интранет-пользователем |
|
|
|
Доступ запрещен |
Возникает, если у пользователя нет административных прав CRM или нет прав на чтение смарт-процесса |
|
|
|
Смарт-процесс не найден |
Смарт-процесс с переданным |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Смарт-процессы: обзор методов
- Создать новый пользовательский тип crm.type.add
- Обновить пользовательский тип crm.type.update
- Получить пользовательский тип по entityTypeId crm.type.getByEntityTypeId
- Получить список пользовательских типов crm.type.list
- Удалить пользовательский тип crm.type.delete
- Получить поля пользовательского типа crm.type.fields