Получить список всех связей дела crm.activity.binding.list
Scope:
crmКто может выполнять метод: пользователь с правом чтения элементов CRM
Метод crm.activity.binding.list получает список всех связей дела.
Метод вернет массив, элементами которого будут массивы, содержащие:
entityTypeId— целочисленный идентификатор типа объекта CRMentityId— целочисленный идентификатор элемента CRM
Результат будет содержать только элементы, к которым у текущего пользователя есть доступ на чтение.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
activityId* |
Целочисленный идентификатор дела в таймлайне, например |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":999}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.binding.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":999,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.binding.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'crm.activity.binding.list',
{
activityId: 999 // ID дела
}
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('crm.activity.binding.list', { activityId: 999 }, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('crm.activity.binding.list', { activityId: 999 }, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'crm.activity.binding.list',
[
'activityId' => 999, // ID дела
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Результат: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Ошибка: ' . $e->getMessage();
}
BX24.callMethod(
'crm.activity.binding.list',
{
activityId: 999 // ID дела
},
function(result) {
if (result.error()) {
console.error('Ошибка:', result.error());
} else {
console.log('Результат:', result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.binding.list',
[
'activityId' => 999 // ID дела
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result":[
{
"entityTypeId": 1,
"entityId": 123
},
{
"entityTypeId": 2,
"entityId": 456
},
{
"entityTypeId": 3,
"entityId": 789
}
],
"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 |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Элемент не найден"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Не переданы обязательные поля |
|
|
Недостаточно прав для выполнении операции |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить связь дела с элементом CRM crm.activity.binding.add
- Удалить связь дела с элементом CRM crm.activity.binding.delete
- Обновить связь дела с элементом CRM crm.activity.binding.move