Получить список полей дела crm.activity.fields
Scope:
crmКто может выполнять метод: любой пользователь
Метод crm.activity.fields возвращает описание полей системного дела.
Параметры метода
Без параметров
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.fields
try
{
const response = await $b24.callMethod(
'crm.activity.fields',
{}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.activity.fields',
[]
);
$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 fetching CRM activity fields: ' . $e->getMessage();
}
BX24.callMethod(
'crm.activity.fields',
{},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID"
},
"OWNER_ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "ID владельца"
},
"OWNER_TYPE_ID": {
"type": "crm_enum_ownertype",
"isRequired": false,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Тип владельца"
},
"TYPE_ID": {
"type": "crm_enum_activitytype",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Тип"
},
"PROVIDER_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID провайдера"
},
"PROVIDER_TYPE_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Тип провайдера"
},
"PROVIDER_GROUP_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Тип коннектора"
},
"ASSOCIATED_ENTITY_ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID связанной с делом сущности"
},
"SUBJECT": {
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Тема"
},
"START_TIME": {
"type": "datetime",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Начало"
},
"END_TIME": {
"type": "datetime",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Срок"
},
"DEADLINE": {
"type": "datetime",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Срок исполнения"
},
"COMPLETED": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Выполнено"
},
"STATUS": {
"type": "crm_enum_activitystatus",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Статус"
},
"RESPONSIBLE_ID": {
"type": "user",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Ответственный"
},
"PRIORITY": {
"type": "crm_enum_activitypriority",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Важность"
},
"NOTIFY_TYPE": {
"type": "crm_enum_activitynotifytype",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Тип уведомлений"
},
"NOTIFY_VALUE": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Параметр уведомления"
},
"DESCRIPTION": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Описание"
},
"DESCRIPTION_TYPE": {
"type": "crm_enum_contenttype",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Тип описания"
},
"DIRECTION": {
"type": "crm_enum_activitydirection",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Направление"
},
"LOCATION": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Место"
},
"CREATED": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата создания"
},
"AUTHOR_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Создал"
},
"LAST_UPDATED": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата изменения"
},
"EDITOR_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Изменил"
},
"SETTINGS": {
"type": "object",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Настройки"
},
"ORIGIN_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Внешний код"
},
"ORIGINATOR_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Внешний источник"
},
"RESULT_STATUS": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RESULT_STATUS"
},
"RESULT_STREAM": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RESULT_STREAM"
},
"RESULT_SOURCE_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RESULT_SOURCE_ID"
},
"PROVIDER_PARAMS": {
"type": "object",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Параметры провайдера"
},
"PROVIDER_DATA": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Данные провайдера"
},
"RESULT_MARK": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RESULT_MARK"
},
"RESULT_VALUE": {
"type": "double",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RESULT_VALUE"
},
"RESULT_SUM": {
"type": "double",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RESULT_SUM"
},
"RESULT_CURRENCY_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RESULT_CURRENCY_ID"
},
"AUTOCOMPLETE_RULE": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Автозаполнение"
},
"BINDINGS": {
"type": "crm_activity_binding",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Привязки"
},
"COMMUNICATIONS": {
"type": "crm_activity_communication",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Канал коммуникации"
},
"FILES": {
"type": "diskfile",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Файлы"
},
"WEBDAV_ELEMENTS": {
"type": "diskfile",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"isDeprecated": true,
"title": "Добавленные файлы"
},
"IS_INCOMING_CHANNEL": {
"type": "char",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "IS_INCOMING_CHANNEL"
}
},
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Значения для поля |
|
time |
Информация о времени выполнения запроса |
Обзор полей системного дела
Обязательные параметры отмечены *
|
Поле |
Описание |
Примечание |
|
|
ID* |
Идентификатор дела |
Только для чтения |
|
|
OWNER_ID* |
Идентификатор элемента CRM |
Можно изменить методом crm.activity.binding.move |
|
|
OWNER_TYPE_ID* |
Неизменяемое |
||
|
TYPE_ID* |
Тип дела |
Обязательный, неизменяемый |
|
|
ASSOCIATED_ENTITY_ID |
Целочисленный идентификатор связанной с делом сущности |
Только для чтения |
|
|
AUTHOR_ID* |
Целочисленный идентификатор пользователя, создавшего дело |
||
|
AUTOCOMPLETE_RULE |
Целочисленный идентификатор правила, по которому сработало автозаполнение |
||
|
BINDINGS |
Привязки к элементам CRM |
Множественное, только для чтения |
|
|
COMMUNICATIONS* |
Множественное, обязательное |
||
|
COMPLETED* |
Флаг, говорящий завершено дело или нет ( |
|
|
|
CREATED* |
Дата и время создания дела |
||
|
DEADLINE |
Дата и время срока исполнения дела |
Поле напрямую не устанавливается, значение берётся из START_TIME для звонка и встречи и из END_TIME для задачи |
|
|
DESCRIPTION |
Текстовое описание дела |
||
|
DESCRIPTION_TYPE |
Тип описания |
||
|
DIRECTION |
Направление дела: входящее/исходящее. |
Актуально для звонков и писем, для встреч не используется |
|
|
EDITOR_ID |
Целочисленный идентификатор пользователя, изменявшего дело |
Только для чтения |
|
|
END_TIME |
Время завершения дела |
||
|
FILES |
Добавленные в дело файлы |
Множественное |
|
|
LAST_UPDATED |
Дата последнего обновления |
Только для чтения |
|
|
LOCATION |
Местоположение |
||
|
NOTIFY_TYPE |
Тип уведомления |
||
|
NOTIFY_VALUE |
Значение уведомления |
Только для чтения |
|
|
ORIGINATOR_ID |
Идентификатор источника данных |
Используется только для привязки к внешнему источнику |
|
|
ORIGIN_ID |
Идентификатор элемента в источнике данных |
Используется только для привязки к внешнему источнику |
|
|
ORIGIN_VERSION |
Оригинальная версия |
Используется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных |
|
|
PRIORITY |
Приоритет |
||
|
PROVIDER_DATA |
Дополнительные данные провайдера |
||
|
PROVIDER_GROUP_ID |
Идентификатор группы провайдера |
||
|
PROVIDER_ID |
Идентификатор провайдера |
Только для чтения |
|
|
PROVIDER_TYPE_ID |
Идентификатор типа провайдера |
Статус из справочника |
|
|
PROVIDER_PARAMS |
Дополнительные параметры провайдера |
||
|
RESPONSIBLE_ID* |
Целочисленный идентификатор пользователя, ответственного за дело |
Обязательное |
|
|
RESULT_CURRENCY_ID |
|||
|
RESULT_MARK |
|||
|
RESULT_SOURCE_ID |
|||
|
RESULT_STATUS |
|||
|
RESULT_STREAM |
Статистика отчётов |
||
|
RESULT_SUM |
|||
|
RESULT_VALUE |
|||
|
SETTINGS |
Доболнительные настройки |
||
|
START_TIME |
Время начала выполнения дела |
||
|
STATUS |
Статус дела |
||
|
SUBJECT |
Дополнительное описание дела |
Обязательное |
|
|
WEBDAV_ELEMENTS |
Добавленные файлы |
Множественное. Устарел, сохраняется для совместимости |
|
|
IS_INCOMING_CHANNEL |
Флаг, говорящий дело создано из входящего канала или нет ( |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить системное дело crm.activity.add
- Обновить системное дело crm.activity.update
- Удалить дело crm.activity.delete
- Получить список дел crm.activity.list
- Получить описание коммуникации crm.activity.communication.fields
- Получить информацию о деле по идентификатору crm.activity.get