task.commentitem.getmanifest — метод REST API Битрикс24

Описание

Метод task.commentitem.getmanifest получает актуальную информацию о методах работы с комментариями задач task.commentitem.*.

Рекомендуем использовать его только в качестве справочника, так как структуру ответа метода разработчик может изменить в любой момент.

Примеры запроса

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**/task.commentitem.getmanifest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.commentitem.getmanifest

// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type ManifestResult = Record<string, unknown>

try {
  const response = await $b24.actions.v2.call.make<ManifestResult>({
    method: 'task.commentitem.getmanifest',
    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(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 getManifest() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'task.commentitem.getmanifest',
        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(result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getManifest)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.task.commentitem.getmanifest().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(
            'task.commentitem.getmanifest',
            []
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result->data(), true);
    echo 'Full Result: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting task comment item manifest: ' . $e->getMessage();
}

BX24.callMethod(
    'task.commentitem.getmanifest',
    [],
    function(result)
    {
        console.info(result.data());
        console.log(result);
    }
);

require_once('crest.php');

$result = CRest::call(
    'task.commentitem.getmanifest',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "task.commentitem.getmanifest", nil)
if err != nil {
	return fmt.Errorf("task.commentitem.getmanifest: %w", err)
}

var item struct {
	ManifestVersion           string `json:"Manifest version"`
	Warning                   string `json:"Warning"`
	RestShortnameAliasToClass string `json:"REST: shortname alias to class"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ManifestVersion, item.Warning)

Ответ

HTTP-статус: 200

{
    "result": {
        "Manifest version": "1.1",
        "Warning": "don't rely on format of this manifest, it can be changed without any notification",
        "REST: shortname alias to class": "commentitem",
        "REST: writable commentitem data fields": [
            "POST_MESSAGE",
            "AUTHOR_ID",
            "POST_DATE",
            "UF_FORUM_MESSAGE_DOC"
        ],
        "REST: readable commentitem data fields": [
            "POST_MESSAGE_HTML",
            "ID",
            "AUTHOR_ID",
            "AUTHOR_NAME",
            "AUTHOR_EMAIL",
            "POST_DATE",
            "POST_DATE",
            "POST_MESSAGE",
            "AUTHOR_ID",
            "POST_DATE",
            "UF_FORUM_MESSAGE_DOC",
            "ATTACHED_OBJECTS"
        ],
        "REST: sortable commentitem data fields": [
            "ID",
            "AUTHOR_ID",
            "AUTHOR_NAME",
            "AUTHOR_EMAIL",
            "POST_DATE"
        ],
        "REST: filterable commentitem data fields": [
            "ID",
            "AUTHOR_ID",
            "AUTHOR_NAME",
            "POST_DATE"
        ],
        "REST: date fields": [
            "POST_DATE"
        ],
        "REST: available methods": {
            "getmanifest": {
                "staticMethod": true,
                "params": []
            },
            "getlist": {
                "staticMethod": true,
                "mandatoryParamsCount": 1,
                "params": [
                    {
                        "description": "taskId",
                        "type": "integer"
                    },
                    {
                        "description": "arOrder",
                        "type": "array",
                        "allowedKeys": [
                            "ID",
                            "AUTHOR_ID",
                            "AUTHOR_NAME",
                            "AUTHOR_EMAIL",
                            "POST_DATE"
                        ]
                    },
                    {
                        "description": "arFilter",
                        "type": "array",
                        "allowedKeys": [
                            "ID",
                            "AUTHOR_ID",
                            "AUTHOR_NAME",
                            "POST_DATE"
                        ],
                        "allowedKeyPrefixes": [
                            "!",
                            "<=",
                            "<",
                            ">=",
                            ">"
                        ]
                    }
                ],
                "allowedKeysInReturnValue": [
                    "POST_MESSAGE_HTML",
                    "ID",
                    "AUTHOR_ID",
                    "AUTHOR_NAME",
                    "AUTHOR_EMAIL",
                    "POST_DATE",
                    "POST_DATE",
                    "POST_MESSAGE",
                    "AUTHOR_ID",
                    "POST_DATE",
                    "UF_FORUM_MESSAGE_DOC",
                    "ATTACHED_OBJECTS"
                ],
                "collectionInReturnValue": true
            },
            "get": {
                "mandatoryParamsCount": 2,
                "params": [
                    {
                        "description": "taskId",
                        "type": "integer"
                    },
                    {
                        "description": "itemId",
                        "type": "integer"
                    }
                ],
                "allowedKeysInReturnValue": [
                    "POST_MESSAGE_HTML",
                    "ID",
                    "AUTHOR_ID",
                    "AUTHOR_NAME",
                    "AUTHOR_EMAIL",
                    "POST_DATE",
                    "POST_DATE",
                    "POST_MESSAGE",
                    "AUTHOR_ID",
                    "POST_DATE",
                    "UF_FORUM_MESSAGE_DOC",
                    "ATTACHED_OBJECTS"
                ]
            },
            "add": {
                "staticMethod": true,
                "mandatoryParamsCount": 2,
                "params": [
                    {
                        "description": "taskId",
                        "type": "integer"
                    },
                    {
                        "description": "arFields",
                        "type": "array",
                        "allowedKeys": [
                            "POST_MESSAGE",
                            "AUTHOR_ID",
                            "POST_DATE",
                            "UF_FORUM_MESSAGE_DOC"
                        ]
                    }
                ]
            },
            "update": {
                "staticMethod": false,
                "mandatoryParamsCount": 3,
                "params": [
                    {
                        "description": "taskId",
                        "type": "integer"
                    },
                    {
                        "description": "itemId",
                        "type": "integer"
                    },
                    {
                        "description": "arFields",
                        "type": "array",
                        "allowedKeys": [
                            "POST_MESSAGE",
                            "AUTHOR_ID",
                            "POST_DATE",
                            "UF_FORUM_MESSAGE_DOC"
                        ]
                    }
                ]
            },
            "delete": {
                "staticMethod": false,
                "mandatoryParamsCount": 2,
                "params": [
                    {
                        "description": "taskId",
                        "type": "integer"
                    },
                    {
                        "description": "itemId",
                        "type": "integer"
                    }
                ]
            },
            "isactionallowed": {
                "staticMethod": false,
                "mandatoryParamsCount": 3,
                "params": [
                    {
                        "description": "taskId",
                        "type": "integer"
                    },
                    {
                        "description": "itemId",
                        "type": "integer"
                    },
                    {
                        "description": "actionId",
                        "type": "integer"
                    }
                ]
            }
        }
    },
    "time": {
        "start": 1753261350.76179,
        "finish": 1753261350.816284,
        "duration": 0.05449390411376953,
        "processing": 0.002237081527709961,
        "date_start": "2025-07-23T12:02:30+03:00",
        "date_finish": "2025-07-23T12:02:30+03:00",
        "operating_reset_at": 1753261950,
        "operating": 0
    }
}

Возвращаемые данные

result object

Описание методов task.commentitem.*

time time

Информация о времени выполнения запроса