Получить тип смарт-процесса

GET /v1/smart-processes/:entityTypeId

Возвращает тип смарт-процесса по entityTypeId.

Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да ID типа сущности. Список: GET /v1/smart-processes

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/smart-processes/174" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/smart-processes/174" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/smart-processes/174', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Тип:', data.title, 'entityTypeId:', data.entityTypeId)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/smart-processes/174', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
data object Тип смарт-процесса. Полный список полей — см. Поля типа

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

JSON 
{
  "success": true,
  "data": {
    "id": 3,
    "entityTypeId": 174,
    "title": "Договоры",
    "code": null,
    "customSectionId": null,
    "isCategoriesEnabled": true,
    "isStagesEnabled": true,
    "isClientEnabled": true,
    "isLinkWithProductsEnabled": true,
    "isObserversEnabled": true,
    "isSourceEnabled": true,
    "isAutomationEnabled": true,
    "isBizProcEnabled": true,
    "isDocumentsEnabled": true,
    "isRecyclebinEnabled": true,
    "isSetOpenPermissions": true,
    "isUseInUserfieldEnabled": true,
    "createdBy": 1,
    "updatedBy": 1,
    "createdTime": "2021-07-20T16:04:10+03:00",
    "updatedTime": "2024-07-19T14:27:27+03:00"
  }
}

Карточка возвращает больше полей, чем список и /fields. В дополнение к полям выше GET /v1/smart-processes/:entityTypeId отдаёт relations (объект с массивами parent/child), linkedUserFields (map) и customSections (массив) — это сквозной проброс от Битрикс24 crm.type.get, которого нет ни в списке, ни в /fields. relations/linkedUserFields документированы как входные поля create/update. customSections — только в ответе карточки.

id ≠ ключ карточки. В ответе есть внутренний id (напр. 3), но карточка адресуется по entityTypeId (напр. 174): GET /v1/smart-processes/<entityTypeId>. GET /v1/smart-processes/<id> вернёт 404 ENTITY_NOT_FOUND — не путайте поле id с ключом пути.

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

404 — тип не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Смарт-процесс не найден"
  }
}

Ошибки

HTTP Код Описание
401 MISSING_API_KEY Заголовок X-Api-Key не передан
401 INVALID_API_KEY Ключ не найден или отозван
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
404 ENTITY_NOT_FOUND Тип с таким entityTypeId не найден
422 BITRIX_ERROR Ошибка от Битрикс24. Конкретная причина — в поле message

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

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