#Список полей смарт-процесса

GET /v1/items/:entityTypeId/userfields

Возвращает список пользовательских полей смарт-процесса. Поддерживает фильтрацию по типу поля и по имени.

#Параметры

Параметр Тип Обяз. Описание
:entityTypeId (path) number да Идентификатор типа смарт-процесса. Источник: `GET /v1/smart-processes` — поле entityTypeId в каждом элементе массива data
userTypeId (query) string нет Фильтр по типу поля. Список допустимых значений — `GET /v1/items/:entityTypeId/userfields/types`. Пример: ?userTypeId=string
fieldName (query) string нет Фильтр по системному имени поля. Пример: ?fieldName=UF_CRM_3_1628508847

Результат упорядочен по полю sort по возрастанию. Параметр сортировки не принимается.

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/items/174/userfields?userTypeId=string" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/items/174/userfields?userTypeId=string" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/items/174/userfields?userTypeId=string',
  {
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  }
)
const { success, data, meta } = await res.json()
console.log(`Полей типа string: ${meta.total}`)

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/items/174/userfields?userTypeId=string',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
const { success, data, meta } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив полей смарт-процесса. Все поля элементов — см. Получить поле
meta.total number Общее количество полей, соответствующих фильтру

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3349,
      "entityId": "CRM_3",
      "fieldName": "UF_CRM_3_1628508847",
      "userTypeId": "crm",
      "xmlId": null,
      "sort": "100",
      "multiple": "Y",
      "mandatory": "N",
      "showFilter": "E",
      "showInList": "Y",
      "editInList": "Y",
      "isSearchable": "Y",
      "settings": {
        "DEAL": "Y"
      }
    },
    {
      "id": 3351,
      "entityId": "CRM_3",
      "fieldName": "UF_CRM_3_1628508893",
      "userTypeId": "string",
      "xmlId": null,
      "sort": "100",
      "multiple": "N",
      "mandatory": "N",
      "showFilter": "E",
      "showInList": "Y",
      "editInList": "Y",
      "isSearchable": "Y",
      "settings": {
        "SIZE": 20,
        "ROWS": 1,
        "REGEXP": "",
        "MIN_LENGTH": 0,
        "MAX_LENGTH": 0,
        "DEFAULT_VALUE": ""
      }
    }
  ],
  "meta": {
    "total": 7
  }
}

Список возвращает базовые поля. Языковые подписи (editFormLabel и др.) и варианты enum приходят только в `GET /v1/items/:entityTypeId/userfields/:id`.

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

403 — у ключа нет скоупа userfieldconfig:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "The request requires higher privileges than provided by the webhook token"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_ENTITY_TYPE_ID :entityTypeId не является положительным целым числом
403 BITRIX_ACCESS_DENIED У ключа нет скоупа userfieldconfig — перевыпустите ключ с этим скоупом
403 SCOPE_DENIED API-ключ не имеет скоупа crm
404 SMART_PROCESS_NOT_FOUND Смарт-процесс с указанным entityTypeId не найден на портале
401 MISSING_API_KEY Отсутствует заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Пагинация отсутствует. Эндпоинт возвращает все поля смарт-процесса без разбивки на страницы. meta.total отражает итоговое число полей в ответе.

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