Получить список цифровых рабочих мест crm.automatedsolution.list
Scope:
crmКто может выполнять метод: пользователи с административным доступом к разделу CRM
Метод вернет массив настроек цифровых рабочих мест. Каждый элемент массива — это структура, аналогичная ответу на запрос crm.automatedsolution.get.
Параметры метода
|
Название |
Описание |
|
order |
Список для сортировки в формате
|
|
filter |
Объект для фильтрации выбранных цифровых рабочих мест в формате
Фильтр может иметь неограниченную вложенность и количество условий. По умолчанию все условия соединяются друг с другом как Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
-
Получить все цифровые рабочие места, отсортированные по убыванию
idcURL (Webhook)cURL (OAuth)JSPHPcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"order":{"id":"DESC"}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.listcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"order":{"id":"DESC"},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.automatedsolution.listBX24.callMethod( "crm.automatedsolution.list", { "order": { "id": "DESC", } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.list', [ 'order' => [ 'id' => 'DESC' ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>'; -
Получить все цифровые рабочие места, название которых начинается с «HR»
cURL (Webhook)cURL (OAuth)JSPHPcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"filter":{"%=title":"HR%"}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.listcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"filter":{"%=title":"HR%"},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.automatedsolution.listBX24.callMethod( "crm.automatedsolution.list", { "filter": { "%=title": "HR%" } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.list', [ 'filter' => [ '%=title' => 'HR%' ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>'; -
Получить все цифровые места, у которых название начинается с «HR» или «Customer» и
idбольше100с сортировкой по названиюcURL (Webhook)cURL (OAuth)JSPHPcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"order":{"title":"ASC"},"filter":{">id":100,"0":{"logic":"OR","0":{"%=title":"HR%"},"1":{"%=title":"Customer%"}}}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.listcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"order":{"title":"ASC"},"filter":{">id":100,"0":{"logic":"OR","0":{"%=title":"HR%"},"1":{"%=title":"Customer%"}}},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.automatedsolution.listBX24.callMethod( "crm.automatedsolution.list", { "order": { "title": "ASC" }, "filter": { ">id": 100, "0": { "logic": "OR", "0": { "%=title": "HR%" }, "1": { "%=title": "Customer%" } } } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.list', [ 'order' => [ 'title' => 'ASC' ], 'filter' => [ '>id' => 100, '0' => [ 'logic' => 'OR', '0' => [ '%=title' => 'HR%' ], '1' => [ '%=title' => 'Customer%' ] ] ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"automatedSolutions": [
{
"id": 238,
"title": "HR",
"typeIds": [
129
]
},
{
"id": 240,
"title": "Customer Success",
"typeIds": []
},
{
"id": 267,
"title": "R&D",
"typeIds": [
14,
158
]
}
]
},
"total": 3,
"time": {
"start": 1715849396.642359,
"finish": 1715849396.954623,
"duration": 0.31226396560668945,
"processing": 0.0068209171295166016,
"date_start": "2024-05-16T11:49:56+03:00",
"date_finish": "2024-05-16T11:49:56+03:00",
"operating_reset_at": 1715849996,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
automatedSolutions |
Массив объектов с информацией о выбранных оплатах |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"ACCESS_DENIED",
"error_description":"Недостаточно прав"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав |
|
|
Неверное значение входных аргументов. Подробности можно узнать в тексте ошибки |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Цифровые рабочие места
- Создать цифровое рабочее место crm.automatedsolution.add
- Изменить цифровое рабочее место crm.automatedsolution.update
- Получить данные о цифровом рабочем месте по id crm.automatedsolution.get
- Удалить цифровое рабочее место crm.automatedsolution.delete
- Получить поля цифрового рабочего места crm.automatedsolution.fields