Delphi ActiveX Box: Update Folder

Back to Index

Renames a folder. This example renames the folder w/ id = 47885473705 to "Old Documents".

Documentation: https://developer.box.com/reference#update-information-about-a-folder

CURL Command

curl https://api.box.com/2.0/folders/47885473705 \
-H "Authorization: Bearer BOX_ACCESS_TOKEN" \
-d '{"name":"Old Documents"}' \
-X PUT

Delphi ActiveX Example

var
rest: TChilkatRest;
success: Integer;
bTls: Integer;
port: Integer;
bAutoReconnect: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
sbResponseBody: TChilkatStringBuilder;
jsonResponse: TChilkatJsonObject;
type: WideString;
id: WideString;
sequence_id: WideString;
etag: WideString;
name: WideString;
created_at: WideString;
modified_at: WideString;
description: WideString;
size: Integer;
path_collectionTotal_count: Integer;
created_byType: WideString;
created_byId: WideString;
created_byName: WideString;
created_byLogin: WideString;
modified_byType: WideString;
modified_byId: WideString;
modified_byName: WideString;
modified_byLogin: WideString;
trashed_at: Integer;
purged_at: Integer;
content_created_at: WideString;
content_modified_at: WideString;
owned_byType: WideString;
owned_byId: WideString;
owned_byName: WideString;
owned_byLogin: WideString;
shared_link: Integer;
folder_upload_email: Integer;
parentType: WideString;
parentId: WideString;
parentSequence_id: Integer;
parentEtag: Integer;
parentName: WideString;
item_status: WideString;
item_collectionTotal_count: Integer;
item_collectionOffset: Integer;
item_collectionLimit: Integer;
i: Integer;
count_i: Integer;
sequence_id_bool: Integer;
etag_bool: Integer;
by: WideString;
direction: WideString;

begin
rest := TChilkatRest.Create(Self);

//  URL: https://api.box.com/2.0/folders/47885473705
bTls := 1;
port := 443;
bAutoReconnect := 1;
success := rest.Connect('api.box.com',port,bTls,bAutoReconnect);
if (success <> 1) then
  begin
    Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(rest.ConnectFailReason));
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

json := TChilkatJsonObject.Create(Self);
json.UpdateString('name','Old Documents');

rest.AddHeader('Authorization','Bearer BOX_ACCESS_TOKEN');

sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);
sbResponseBody := TChilkatStringBuilder.Create(Self);
success := rest.FullRequestSb('PUT','/2.0/folders/47885473705',sbRequestBody.ControlInterface,sbResponseBody.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

jsonResponse := TChilkatJsonObject.Create(Self);
jsonResponse.LoadSb(sbResponseBody.ControlInterface);

type := jsonResponse.StringOf('type');
id := jsonResponse.StringOf('id');
sequence_id := jsonResponse.StringOf('sequence_id');
etag := jsonResponse.StringOf('etag');
name := jsonResponse.StringOf('name');
created_at := jsonResponse.StringOf('created_at');
modified_at := jsonResponse.StringOf('modified_at');
description := jsonResponse.StringOf('description');
size := jsonResponse.IntOf('size');
path_collectionTotal_count := jsonResponse.IntOf('path_collection.total_count');
created_byType := jsonResponse.StringOf('created_by.type');
created_byId := jsonResponse.StringOf('created_by.id');
created_byName := jsonResponse.StringOf('created_by.name');
created_byLogin := jsonResponse.StringOf('created_by.login');
modified_byType := jsonResponse.StringOf('modified_by.type');
modified_byId := jsonResponse.StringOf('modified_by.id');
modified_byName := jsonResponse.StringOf('modified_by.name');
modified_byLogin := jsonResponse.StringOf('modified_by.login');
trashed_at := jsonResponse.IsNullOf('trashed_at');
purged_at := jsonResponse.IsNullOf('purged_at');
content_created_at := jsonResponse.StringOf('content_created_at');
content_modified_at := jsonResponse.StringOf('content_modified_at');
owned_byType := jsonResponse.StringOf('owned_by.type');
owned_byId := jsonResponse.StringOf('owned_by.id');
owned_byName := jsonResponse.StringOf('owned_by.name');
owned_byLogin := jsonResponse.StringOf('owned_by.login');
shared_link := jsonResponse.IsNullOf('shared_link');
folder_upload_email := jsonResponse.IsNullOf('folder_upload_email');
parentType := jsonResponse.StringOf('parent.type');
parentId := jsonResponse.StringOf('parent.id');
parentSequence_id := jsonResponse.IsNullOf('parent.sequence_id');
parentEtag := jsonResponse.IsNullOf('parent.etag');
parentName := jsonResponse.StringOf('parent.name');
item_status := jsonResponse.StringOf('item_status');
item_collectionTotal_count := jsonResponse.IntOf('item_collection.total_count');
item_collectionOffset := jsonResponse.IntOf('item_collection.offset');
item_collectionLimit := jsonResponse.IntOf('item_collection.limit');
i := 0;
count_i := jsonResponse.SizeOfArray('path_collection.entries');
while i < count_i do
  begin
    jsonResponse.I := i;
    type := jsonResponse.StringOf('path_collection.entries[i].type');
    id := jsonResponse.StringOf('path_collection.entries[i].id');
    sequence_id_bool := jsonResponse.IsNullOf('path_collection.entries[i].sequence_id');
    etag_bool := jsonResponse.IsNullOf('path_collection.entries[i].etag');
    name := jsonResponse.StringOf('path_collection.entries[i].name');
    i := i + 1;
  end;

i := 0;
count_i := jsonResponse.SizeOfArray('item_collection.entries');
while i < count_i do
  begin
    jsonResponse.I := i;
    i := i + 1;
  end;

i := 0;
count_i := jsonResponse.SizeOfArray('item_collection.order');
while i < count_i do
  begin
    jsonResponse.I := i;
    by := jsonResponse.StringOf('item_collection.order[i].by');
    direction := jsonResponse.StringOf('item_collection.order[i].direction');
    i := i + 1;
  end;

Sample JSON Response Body

{
  "type": "folder",
  "id": "47885473705",
  "sequence_id": "1",
  "etag": "1",
  "name": "Old Documents",
  "created_at": "2018-03-16T06:54:57-07:00",
  "modified_at": "2018-03-17T08:36:09-07:00",
  "description": "",
  "size": 0,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "folder",
        "id": "0",
        "sequence_id": null,
        "etag": null,
        "name": "All Files"
      }
    ]
  },
  "created_by": {
    "type": "user",
    "id": "2787704945",
    "name": "chilkat",
    "login": "AutomationUser_434741_3nmGYSS7o5@@boxdevedition.com"
  },
  "modified_by": {
    "type": "user",
    "id": "2787704945",
    "name": "chilkat",
    "login": "AutomationUser_434741_3nmGYSS7o5@@boxdevedition.com"
  },
  "trashed_at": null,
  "purged_at": null,
  "content_created_at": "2018-03-16T06:54:57-07:00",
  "content_modified_at": "2018-03-17T08:36:09-07:00",
  "owned_by": {
    "type": "user",
    "id": "2787704945",
    "name": "chilkat",
    "login": "AutomationUser_434741_3nmGYSS7o5@@boxdevedition.com"
  },
  "shared_link": null,
  "folder_upload_email": null,
  "parent": {
    "type": "folder",
    "id": "0",
    "sequence_id": null,
    "etag": null,
    "name": "All Files"
  },
  "item_status": "active",
  "item_collection": {
    "total_count": 0,
    "entries": [
    ],
    "offset": 0,
    "limit": 100,
    "order": [
      {
        "by": "type",
        "direction": "ASC"
      },
      {
        "by": "name",
        "direction": "ASC"
      }
    ]
  }
}