Добавить пользовательский тип дела crm.activity.type.add
Scope:
crmКто может выполнять метод:
любой пользователь
Метод crm.activity.type.add регистрирует пользовательский тип дела с указанием названия и иконки.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей для добавления нового пользовательского типа дела в виде структуры:
Подробное описание приведено ниже |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
TYPE_ID* |
Строковое значение типа дела, например |
|
NAME |
Название типа дела, например |
|
ICON_FILE |
Файл иконки типа дела, описанный по правилам |
|
IS_CONFIGURABLE_TYPE |
Значение по умолчанию - |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":"1C","NAME":"Дело 1C","ICON_FILE":"@type-icon","IS_CONFIGURABLE_TYPE":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.type.add
После этого достаточно при создании дела указывать свой тип, иконка и название будут подгружаться автоматически.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_TYPE_ID":1,"OWNER_ID":selectedEntityId,"PROVIDER_ID":"REST_APP","PROVIDER_TYPE_ID":"1C","SUBJECT":"Новое дело","COMPLETED":"N","RESPONSIBLE_ID":1,"DESCRIPTION":"Описание нового дела"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.add
try
{
const response = await $b24.callMethod(
"crm.activity.type.add",
{
fields:
{
"TYPE_ID": '1C',
"NAME": "Дело 1C",
'ICON_FILE': document.getElementById('type-icon'), // file input node
"IS_CONFIGURABLE_TYPE": "N"
}
}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.activity.type.add',
[
'fields' => [
'TYPE_ID' => '1C',
'NAME' => 'Дело 1C',
'ICON_FILE' => $_FILES['type-icon'], // file input node
'IS_CONFIGURABLE_TYPE' => 'N',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding activity type: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.type.add",
{
fields:
{
"TYPE_ID": '1C',
"NAME": "Дело 1C",
'ICON_FILE': document.getElementById('type-icon'), // file input node
"IS_CONFIGURABLE_TYPE": "N"
}
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
После этого достаточно при создании дела указывать свой тип, иконка и название будут подгружаться автоматически.
BX24.callMethod(
'crm.activity.add',
{
fields:
{
"OWNER_TYPE_ID": 1,
"OWNER_ID": selectedEntityId,
"PROVIDER_ID": 'REST_APP',
"PROVIDER_TYPE_ID": '1C',
"SUBJECT": "Новое дело",
"COMPLETED": "N",
"RESPONSIBLE_ID": 1,
"DESCRIPTION": "Описание нового дела"
}
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.type.add',
[
'fields' => [
'TYPE_ID' => '1C',
'NAME' => 'Дело 1C',
'ICON_FILE' => $_FILES['type-icon'], // Assuming file input is handled
'IS_CONFIGURABLE_TYPE' => 'N'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
После этого достаточно при создании дела указывать свой тип, иконка и название будут подгружаться автоматически.
require_once('crest.php');
$result = CRest::call(
'crm.activity.add',
[
'fields' => [
'OWNER_TYPE_ID' => 1,
'OWNER_ID' => $selectedEntityId, // Assuming this variable is defined
'PROVIDER_ID' => 'REST_APP',
'PROVIDER_TYPE_ID' => '1C',
'SUBJECT' => 'Новое дело',
'COMPLETED' => 'N',
'RESPONSIBLE_ID' => 1,
'DESCRIPTION' => 'Описание нового дела'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+02:00",
"date_finish": "2025-01-21T13:47:08+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит:
|
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Not found."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для выполнения операции |
|
|
Метод работает только в контексте приложений |
|
|
Не заполнено обязательное поле |
|
|
Пользовательский тип дела с указанным |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список пользовательских типов дел crm.activity.type.list
- Удалить пользовательский тип дел crm.activity.type.delete