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

GET /v1/smart-processes/:entityTypeId

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

#Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да ID типа сущности (из ответа list)

#Примеры

#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()

#Поля ответа

Поле Тип Описание
id number ID типа
entityTypeId number ID типа сущности
title string Название
isCategoriesEnabled boolean Воронки включены
isStagesEnabled boolean Стадии включены
isClientEnabled boolean Поля клиента
isLinkWithProductsEnabled boolean Товарные позиции
isObserversEnabled boolean Наблюдатели
isSourceEnabled boolean Источник
isAutomationEnabled boolean Автоматизация
isBizProcEnabled boolean Бизнес-процессы
createdBy number Создатель
createdTime datetime Дата создания
updatedTime datetime Дата изменения

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

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

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Тип с таким entityTypeId не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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