метод REST
scope: crm
crm.timeline.comment.fields
Получить поля комментария
Описание
Метод получает поля дела типа «Комментарий».
Без параметров.
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.comment.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.comment.fields
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FieldDescriptor = {
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
isDynamic: boolean
title: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type CommentFieldsResult = Record<string, FieldDescriptor>
try {
const response = await $b24.actions.v2.call.make<CommentFieldsResult>({
method: 'crm.timeline.comment.fields',
params: {},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(Object.keys(result), result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getTimelineCommentFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.comment.fields',
params: {},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(Object.keys(result), result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTimelineCommentFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.timeline.comment.fields().response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.timeline.comment.fields'
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching timeline comment fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.comment.fields",
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call('crm.timeline.comment.fields');
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.timeline.comment.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.timeline.comment.fields: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))
Ответ
HTTP-статус: 200
{
"result": {
"ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID"
},
"CREATED": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата добавления"
},
"ENTITY_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "ID элемента, к которому привязан комментарий"
},
"ENTITY_TYPE": {
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Тип элемента, к которому привязан комментарий"
},
"AUTHOR_ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Автор"
},
"COMMENT": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Текст комментария"
},
"FILES": {
"type": "attached_diskfile",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true,
"isDynamic": false,
"title": "Список файлов"
}
},
"time": {
"start": 1715091541.642592,
"finish": 1715091541.730599,
"duration": 0.08800697326660156,
"date_start": "2024-05-03T17:19:01+03:00",
"date_finish": "2024-05-03T17:19:01+03:00",
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой элемент ответа, содержащий все поля комментария
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "error"
}
| Код | Описание | Значение |
|---|---|---|
0 |
error | Другие ошибки (например, фатальные ошибки) |

