Для AI-агентов: markdown этой страницы — /docs-content/entities/sites/ai/field.md индекс документации — /llms.txt
Получить одно поле генерации
GET /v1/sites/ai/fields/:name
Получает определение поля по имени.
Параметры
| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
Параметрname (path) |
Типstring | Обяз.да | По умолч.— | ОписаниеИмя поля из словаря |
Примеры
curl — личный ключ
curl -X GET "https://vibecode.bitrix24.tech/v1/sites/ai/fields/id" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl -X GET "https://vibecode.bitrix24.tech/v1/sites/ai/fields/id" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch("https://vibecode.bitrix24.tech/v1/sites/ai/fields/id", {
"method": "GET",
"headers": {
"X-Api-Key": "YOUR_API_KEY"
}
});
const result = await res.json();
console.log(result);
JavaScript — OAuth-приложение
const res = await fetch("https://vibecode.bitrix24.tech/v1/sites/ai/fields/id", {
"method": "GET",
"headers": {
"X-Api-Key": "YOUR_APP_KEY",
"Authorization": "Bearer USER_SESSION_TOKEN"
}
});
const result = await res.json();
console.log(result);
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue при успехе |
Полеdata |
Типobject | ОписаниеОпределение поля |
Полеdata.name |
Типstring | ОписаниеИмя поля |
Полеdata.type |
Типstring | ОписаниеТип значения |
Полеdata.title |
Типstring | ОписаниеНазвание поля |
Полеdata.description |
Типstring | null | ОписаниеОписание поля или null |
Полеdata.validationRules |
Типarray | ОписаниеПравила проверки |
Полеdata.requiredGroups |
Типarray | null | ОписаниеГруппы обязательности или null |
Полеdata.filterable |
Типboolean | ОписаниеДоступность фильтрации |
Полеdata.sortable |
Типboolean | ОписаниеДоступность сортировки |
Полеdata.editable |
Типboolean | ОписаниеДоступность изменения |
Полеdata.editableGroups |
Типarray | null | ОписаниеГруппы изменения или null |
Полеdata.multiple |
Типboolean | ОписаниеМножественное значение |
Полеdata.elementType |
Типstring | null | ОписаниеТип элемента или null |
Пример ответа
{
"success": true,
"data": {
"name": "id",
"type": "int",
"title": "Site generation identifier",
"description": null,
"validationRules": [],
"requiredGroups": null,
"filterable": false,
"sortable": false,
"editable": false,
"editableGroups": null,
"multiple": false,
"elementType": null
}
}
Пример ответа при ошибке
{
"success": false,
"error": {
"code": "ENTITY_NOT_FOUND",
"message": "Поле `FAKE_UNKNOWN_FIELD` не найдено"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеБитрикс24 отказал в запросе |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан заголовок X-Api-Key |
| HTTP401 | КодINVALID_API_KEY |
ОписаниеПлатформа не знает переданную строку ключа |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеКлюч приложения vibe_app_* передан без заголовка Authorization: Bearer с токеном сессии |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ личного ключа vibe_api_* нет вебхука портала. Причина приходит в error.details |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не выдан скоуп landing |