Delphi DLL Box: Get Folder Items

Back to Index

Gets all of the files, folders, or web links contained within a folder.

Documentation: https://developer.box.com/reference#get-a-folders-items

CURL Command

curl https://api.box.com/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0 \
-H "Authorization: Bearer BOX_ACCESS_TOKEN"

Delphi DLL Example

var
rest: HCkRest;
success: Boolean;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
sbResponseBody: HCkStringBuilder;
jsonResponse: HCkJsonObject;
total_count: Integer;
offset: Integer;
limit: Integer;
i: Integer;
count_i: Integer;
type: PWideChar;
id: PWideChar;
file_versionType: PWideChar;
file_versionId: PWideChar;
file_versionSha1: PWideChar;
sequence_id: PWideChar;
etag: PWideChar;
sha1: PWideChar;
name: PWideChar;
by: PWideChar;
direction: PWideChar;

begin
rest := CkRest_Create();

//  URL: https://api.box.com/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0
bTls := True;
port := 443;
bAutoReconnect := True;
success := CkRest_Connect(rest,'api.box.com',port,bTls,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(CkRest_getConnectFailReason(rest)));
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

CkRest_AddHeader(rest,'Authorization','Bearer BOX_ACCESS_TOKEN');

sbResponseBody := CkStringBuilder_Create();
success := CkRest_FullRequestNoBodySb(rest,'GET','/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0',sbResponseBody);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

jsonResponse := CkJsonObject_Create();
CkJsonObject_LoadSb(jsonResponse,sbResponseBody);

total_count := CkJsonObject_IntOf(jsonResponse,'total_count');
offset := CkJsonObject_IntOf(jsonResponse,'offset');
limit := CkJsonObject_IntOf(jsonResponse,'limit');
i := 0;
count_i := CkJsonObject_SizeOfArray(jsonResponse,'entries');
while i < count_i do
  begin
CkJsonObject_putI(jsonResponse,i);
    type := CkJsonObject__stringOf(jsonResponse,'entries[i].type');
    id := CkJsonObject__stringOf(jsonResponse,'entries[i].id');
    file_versionType := CkJsonObject__stringOf(jsonResponse,'entries[i].file_version.type');
    file_versionId := CkJsonObject__stringOf(jsonResponse,'entries[i].file_version.id');
    file_versionSha1 := CkJsonObject__stringOf(jsonResponse,'entries[i].file_version.sha1');
    sequence_id := CkJsonObject__stringOf(jsonResponse,'entries[i].sequence_id');
    etag := CkJsonObject__stringOf(jsonResponse,'entries[i].etag');
    sha1 := CkJsonObject__stringOf(jsonResponse,'entries[i].sha1');
    name := CkJsonObject__stringOf(jsonResponse,'entries[i].name');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jsonResponse,'order');
while i < count_i do
  begin
CkJsonObject_putI(jsonResponse,i);
    by := CkJsonObject__stringOf(jsonResponse,'order[i].by');
    direction := CkJsonObject__stringOf(jsonResponse,'order[i].direction');
    i := i + 1;
  end;

CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jsonResponse);

Sample JSON Response Body

{
  "total_count": 2,
  "entries": [
    {
      "type": "file",
      "id": "246181882790",
      "file_version": {
        "type": "file_version",
        "id": "259636211878",
        "sha1": "c9d2492fb97f88a9b4d1e35f32a3410e95853f18"
      },
      "sequence_id": "0",
      "etag": "0",
      "sha1": "c9d2492fb97f88a9b4d1e35f32a3410e95853f18",
      "name": "hedgehogs.jpg"
    },
    {
      "type": "file",
      "id": "246167973161",
      "file_version": {
        "type": "file_version",
        "id": "259621592361",
        "sha1": "df7be9dc4f467187783aca68c7ce98e4df2172d0"
      },
      "sequence_id": "0",
      "etag": "0",
      "sha1": "df7be9dc4f467187783aca68c7ce98e4df2172d0",
      "name": "penguins.jpg"
    }
  ],
  "offset": 0,
  "limit": 2,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    },
    {
      "by": "name",
      "direction": "ASC"
    }
  ]
}