Get Table Fields biconnector.table.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/biconnector.table.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
        
        // Methods of this section put errors inside result and answer with HTTP 200
        type BiconnectorError = {
          error: {
            error: string
            error_description: string
          }
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type TableFieldsResult = {
          fields: {
            title: string
            type: string
            isRequired: boolean
            isReadOnly: boolean
            isImmutable: boolean
            isMultiple: boolean
          }[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<TableFieldsResult | BiconnectorError>({
            method: 'biconnector.table.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
        
            // The SDK sees HTTP 200 as success, so check the error inside result yourself
            if ('error' in result) {
              console.error(result.error.error, result.error.error_description)
            } else {
              console.info('Table entity fields count:', result.fields.length, result.fields)
            }
          }
        } 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 getTableFields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'biconnector.table.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
        
              // The SDK sees HTTP 200 as success, so check the error inside result yourself
              if (result && result.error) {
                console.error(result.error.error, result.error.error_description)
                return
              }
        
              console.info('Table entity fields count:', result.fields.length, result.fields)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getTableFields)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            # b24pysdk has no ready-made wrapper for biconnector.table.*, so the method
            # is called directly through bitrix_token.call_method()
            response = bitrix_token.call_method(
                api_method="biconnector.table.fields",
            )
            result = response["result"]
        
            # Methods of this section put errors inside result and answer with HTTP 200
            if isinstance(result, dict) and "error" in result:
                print(
                    "BIconnector error",
                    f"error: {result['error']['error']}",
                    f"error_description: {result['error']['error_description']}",
                    sep="\n",
                )
            else:
                print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

try {
            $response = $b24Service
                ->core
                ->call(
                    'biconnector.table.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                $data = $result->data();
        
                // Methods of this section put errors inside result and answer with HTTP 200
                if (isset($data['error'])) {
                    echo 'BIconnector error: ' . $data['error']['error'] . ': ' . $data['error']['error_description'];
                } else {
                    echo 'Success: ' . print_r($data, true);
                }
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling biconnector.table.fields: ' . $e->getMessage();
        }
        

BX24.callMethod(
            'biconnector.table.fields',
            {},
            (result) => {
                if (result.error()) {
                    console.error(result.error());
                    return;
                }
        
                const data = result.data();
        
                // Methods of this section put errors inside result and answer with HTTP 200
                if (data && data.error) {
                    console.error(data.error.error, data.error.error_description);
                    return;
                }
        
                console.info(data);
            },
        );
        

require_once('crest.php');
        
        $result = CRest::call(
            'biconnector.table.fields',
            []
        );
        
        // Methods of this section put errors inside result and answer with HTTP 200
        if (isset($result['result']['error'])) {
            echo 'BIconnector error: ' . $result['result']['error']['error']
                . ': ' . $result['result']['error']['error_description'];
        } else {
            echo '<PRE>';
            print_r($result);
            echo '</PRE>';
        }
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "biconnector.table.fields", nil, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("biconnector.table.fields: %w", err)
        }
        
        // Methods of this section put errors inside result and answer with HTTP 200.
        var apiErr struct {
        	Error *struct {
        		Error       string `json:"error"`
        		Description string `json:"error_description"`
        	} `json:"error"`
        }
        if err := json.Unmarshal(res.Result, &apiErr); err == nil && apiErr.Error != nil {
        	return fmt.Errorf("biconnector.table.fields: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
        }
        
        // The method wraps the response in an object with the "fields" key.
        raw, ok := b24.Unwrap(res.Result, "fields")
        if !ok {
        	return fmt.Errorf("no fields key in the response")
        }
        
        var items []struct {
        	Title       string `json:"title"`
        	Type        string `json:"type"`
        	IsRequired  bool   `json:"isRequired"`
        	IsReadOnly  bool   `json:"isReadOnly"`
        	IsImmutable bool   `json:"isImmutable"`
        	IsMultiple  bool   `json:"isMultiple"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.Title)
        }