Skip to content

disk-folder-get-fields.md

Latest commit

 

History

History
368 lines (312 loc) · 10 KB

disk-folder-get-fields.md

File metadata and controls

368 lines (312 loc) · 10 KB
Raw

Get Folder Field Descriptions disk.folder.getFields

{% note tip "" %}

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

{% endnote %}

Scope: disk

Who can execute the method: any user

The method disk.folder.getFields returns the description of folder fields.

Method Parameters

No parameters.

Code Examples

{% include Examples Note %}

{% list tabs %}

  • cURL (Webhook)

    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**/disk.folder.getFields

  • cURL (OAuth)

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

  • JS (TS)

    // 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 FolderField = {
  TYPE: string
  USE_IN_FILTER: boolean
  USE_IN_SHOW: boolean
}

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

try {
  const response = await $b24.actions.v2.call.make<FolderFieldsResult>({
    method: 'disk.folder.getFields',
    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['NAME'])
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

  • JS (UMD)

    <!-- 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 getFolderFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

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

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

  • Python

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.disk.folder.getfields().response
    result = bitrix_response.result
    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}")

  • PHP

    try {
    $response = $b24Service
        ->core
        ->call(
            'disk.folder.getFields',
            []
        );

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

    echo 'Success: ' . print_r($result, true);
    processData($result);

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

  • BX24.js

    BX24.callMethod(
    "disk.folder.getFields",
    {},
    function (result) {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

  • PHP CRest

    require_once('crest.php');

$result = CRest::call(
    'disk.folder.getFields',
    []
);

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

  • Go

    // client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "disk.folder.getFields", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("disk.folder.getFields: %w", err)
}

keys, ok := b24.Keys(res.Result)
if !ok {
	return fmt.Errorf("expected an object in the response")
}
fmt.Println("fields in response:", len(keys))

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": {
        "ID": {
            "TYPE": "integer",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "NAME": {
            "TYPE": "string",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "TYPE": {
            "TYPE": "enum",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "CODE": {
            "TYPE": "string",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "STORAGE_ID": {
            "TYPE": "integer",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "REAL_OBJECT_ID": {
            "TYPE": "integer",
            "USE_IN_FILTER": false,
            "USE_IN_SHOW": true
        },
        "PARENT_ID": {
            "TYPE": "integer",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "CREATE_TIME": {
            "TYPE": "datetime",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "UPDATE_TIME": {
            "TYPE": "datetime",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "DELETE_TIME": {
            "TYPE": "datetime",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "CREATED_BY": {
            "TYPE": "integer",
            "USE_IN_FILTER": false,
            "USE_IN_SHOW": true
        },
        "UPDATED_BY": {
            "TYPE": "integer",
            "USE_IN_FILTER": false,
            "USE_IN_SHOW": true
        },
        "DELETED_BY": {
            "TYPE": "integer",
            "USE_IN_FILTER": false,
            "USE_IN_SHOW": true
        },
        "DELETED_TYPE": {
            "TYPE": "enum",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        }
    },
    "time": {
        "start": 1768343226,
        "finish": 1768343226.742822,
        "duration": 0.7428219318389893,
        "processing": 0,
        "date_start": "2026-01-13T16:47:06+01:00",
        "date_finish": "2026-01-13T16:47:06+01:00",
        "operating_reset_at": 1768343826,
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result array | Array with the description of folder fields.

The structure of each field description:

  • TYPE — data type of the field
  • USE_IN_FILTER — ability to use the field for filtering
  • USE_IN_SHOW — availability of the field when receiving a response || || ID integer | Folder identifier || || NAME string | Folder name || || TYPE enum | Object type || || CODE string | Symbolic code of the folder || || STORAGE_ID integer | Identifier of the storage where the folder is located || || REAL_OBJECT_ID integer | Object identifier || || PARENT_ID integer | Identifier of the parent folder || || CREATE_TIME datetime | Date and time of folder creation || || UPDATE_TIME datetime | Date and time of the last update of the folder || || DELETE_TIME datetime | Date and time of moving the folder to the trash || || CREATED_BY integer | Identifier of the user who created the folder || || UPDATED_BY integer | Identifier of the user who made the last change || || DELETED_BY integer | Identifier of the user who deleted the folder || || DELETED_TYPE enum | Deletion status of the object || || time time | Information about the execution time of the request || |#

Error Handling

{% include system errors %}

Continue Learning