crm.documentgenerator.template.getfields

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"entityTypeId":2,"entityId":123,"values":{"DocumentNumber":"2026-001"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.getfields

// 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 GetFieldsResult = {
  templateFields: Record<string, TemplateField>
}

type TemplateField = {
  title: string
  value: string | string[] | null
  default?: string | null
  required?: string
  type?: string
  group: string[]
  chain?: string
}

try {
  const response = await $b24.actions.v2.call.make<GetFieldsResult>({
    method: 'crm.documentgenerator.template.getfields',
    params: {
      id: 1,
      entityTypeId: 2,
      entityId: 123,
      values: {
        DocumentNumber: '2026-001',
      },
    },
    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('Template fields:', Object.keys(result.templateFields))
  }
} 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 getTemplateFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.documentgenerator.template.getfields',
        params: {
          id: 1,
          entityTypeId: 2,
          entityId: 123,
          values: {
            DocumentNumber: '2026-001',
          },
        },
        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('Template fields:', Object.keys(result.templateFields))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.documentgenerator.template.getfields(
        bitrix_id=1,
        entity_type_id=2,
        entity_id=123,
        values={
            "DocumentNumber": "2026-001",
        },
    ).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.documentgenerator.template.getfields',
            [
                'id' => 1,
                'entityTypeId' => 2,
                'entityId' => 123,
                'values' => [
                    'DocumentNumber' => '2026-001',
                ],
            ]
        );

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

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

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting template fields: ' . $e->getMessage();
}

BX24.callMethod(
    'crm.documentgenerator.template.getfields',
    {
        id: 1,
        entityTypeId: 2,
        entityId: 123,
        values: {
            DocumentNumber: '2026-001',
        },
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);

require_once('crest.php');

$result = CRest::call(
    'crm.documentgenerator.template.getfields',
    [
        'id' => 1,
        'entityTypeId' => 2,
        'entityId' => 123,
        'values' => [
            'DocumentNumber' => '2026-001',
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.template.getfields", b24.Params{
	"id":           1,
	"entityTypeId": 2,
	"entityId":     123,
	"values": b24.Params{
		"DocumentNumber": "2026-001",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.documentgenerator.template.getfields: %w", err)
}

// Метод заворачивает ответ в объект с ключом "templateFields".
raw, ok := b24.Unwrap(res.Result, "templateFields")
if !ok {
	return fmt.Errorf("в ответе нет ключа templateFields")
}

fmt.Printf("%s\n", raw)