Get fields structure for folder items filter

Returns filter structure for child folder items

Parameters

Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
Clear	--empty	Boolean	✖	True > structure with empty values, False > field types at values
Token	--token	String	✖	Access token, when app auth method used

Returns

Structure Of KeyAndValue - Fields structure

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: disk.folder.getfields

1C:Enterprise/OneScript code example

    URL = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";

    Result = OPI_Bitrix24.GetFolderFilterStructure(URL);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "a5b00469006e9f06006b12e400000001000...";

    Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token);

Bash

    oint bitrix24 GetFolderFilterStructure \
      --url "b24-ar17wx.bitrix24.by" \
      --empty true \
      --token "***"

CMD/Bat

    oint bitrix24 GetFolderFilterStructure ^
      --url "b24-ar17wx.bitrix24.by" ^
      --empty true ^
      --token "***"

Result

{
 "ID": "",
 "NAME": "",
 "TYPE": "",
 "CODE": "",
 "STORAGE_ID": "",
 "PARENT_ID": "",
 "CREATE_TIME": "",
 "UPDATE_TIME": "",
 "DELETE_TIME": "",
 "DELETED_TYPE": ""
}