Для AI-агентов: markdown этой страницы — /docs-content/entities/automated-solutions/list.md индекс документации — /llms.txt

Список рабочих мест

GET /v1/automated-solutions

Возвращает список цифровых рабочих мест портала вместе с типами смарт-процессов, привязанными к каждому рабочему месту.

Параметры

Параметр Тип По умолч. Описание
filter (query) object — Фильтрация по полям id и title из GET /v1/automated-solutions/fields.
Синтаксис фильтрации. Пример: ?filter[id]=7
order (query) object id по возрастанию Сортировка по полям id и title: ?order[title]=asc. Короткая форма — ?sort=title, по убыванию ?sort=-title
select (query) string — Выборка полей: ?select=id,title
limit (query) number 50 Количество записей, до 5000
offset (query) number 0 Пропустить N записей

Постраничная выборка: при limit больше 50 Вайбкод сам собирает ответ из нескольких страниц. Максимум — 5000 записей за вызов.

Примеры

curl — личный ключ

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/automated-solutions?limit=10&order[title]=asc" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/automated-solutions?limit=10&order[title]=asc" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/automated-solutions?limit=10&order[title]=asc', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
for (const place of data) {
  console.log(place.id, place.title, 'типов:', place.typeIds.length)
}

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/automated-solutions?limit=10&order[title]=asc', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив рабочих мест
data[].id number Идентификатор рабочего места
data[].title string Название рабочего места
data[].typeIds array Идентификаторы привязанных типов смарт-процессов — поле id типа из GET /v1/smart-processes, а не его entityTypeId. Пустой массив, если типы не привязаны
meta.total number Общее количество рабочих мест под фильтром
meta.hasMore boolean Есть ли ещё записи за пределами limit

Пример ответа

JSON 
{
  "success": true,
  "data": [
    { "id": 1, "title": "yay", "typeIds": [3, 13, 15] },
    { "id": 11, "title": "Закупки", "typeIds": [] },
    { "id": 9, "title": "Кадровые процессы", "typeIds": [63] }
  ],
  "meta": {
    "total": 3,
    "hasMore": false
  }
}

Пример ответа при ошибке

400 — фильтр по полю typeIds:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'typeIds' for entity 'automated-solutions'. Available: id, title"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, кроме id и title, в том числе по typeIds. Запрос отклоняется до обращения к порталу
400 UNKNOWN_SORT_FIELD Сортировка по полю, кроме id и title, в любой из двух форм — order[typeIds]=asc или sort=typeIds. Запрос отклоняется до обращения к порталу
400 INVALID_FILTER Значение filter не разобрано: в одном запросе смешаны JSON-форма filter={...} и форма с квадратными скобками filter[...], либо строка не является JSON-объектом
401 MISSING_API_KEY Заголовок X-Api-Key не передан
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа crm
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

Полный список общих ошибок API — Ошибки.

Известные особенности

Рабочие места с одинаковым названием. При сортировке по title Вайбкод добавляет вторым ключом id по возрастанию. Рабочие места с одинаковым названием идут в одном и том же порядке на каждой странице, поэтому при обходе через offset записи не теряются и не повторяются.

Смотрите также