#Поля комментария

GET /v1/timelines/fields

Возвращает схему полей комментария таймлайна.

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/timelines/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

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

const { success, data } = await res.json()
console.log('Поля:', Object.keys(data.fields))

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

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

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

#Поля ответа

Поле Bitrix24 Тип RO Описание
id ID number да ID комментария
entityType ENTITY_TYPE string Тип родительской записи CRM: deal, lead, contact, company или DYNAMIC_<entityTypeId> для смарт-процессов (например, DYNAMIC_174). В ответе приходит в нижнем регистре (dynamic_174). Задаётся только при создании
entityId ENTITY_ID number ID родительской записи. Задаётся только при создании. Источник: GET /v1/deals, GET /v1/leads, GET /v1/contacts, GET /v1/companies, GET /v1/items/:entityTypeId (элементы смарт-процессов)
comment COMMENT string Текст комментария. Обязателен при создании
authorId AUTHOR_ID number да ID автора комментария. Данные пользователя по ID: GET /v1/users/:id
createdAt CREATED datetime да Дата создания, ISO 8601 в UTC

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityType": { "type": "string", "readonly": false },
      "entityId": { "type": "number", "readonly": false },
      "comment": { "type": "string", "readonly": false },
      "authorId": { "type": "number", "readonly": false },
      "createdAt": { "type": "datetime", "readonly": true }
    }
  }
}

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "Requires 'crm' scope"
  }
}

#Ошибки

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

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

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