(JavaScript) Frame.io - Create a Folder

Create a folder asset as a child to the root_asset_id.

For more information, see https://docs.frame.io/docs/root-asset-ids

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var http = new CkHttp();

// Implements the following CURL command:

// curl --request POST \
// --url https://api.frame.io/v2/assets/<root_asset_id>/children \
// --header 'authorization: Bearer <FRAME_IO_DEV_TOKEN>' \
// --header 'content-type: application/json' \
// --data '{"type":"folder", "name": "Folder at root"}'

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "type": "folder",
//   "name": "Folder at root"
// }

var json = new CkJsonObject();
json.UpdateString("type","folder");
json.UpdateString("name","Folder at root");

http.SetRequestHeader("content-type","application/json");
// Adds the "Authorization: Bearer <FRAME_IO_DEV_TOKEN>" header.
http.AuthToken = "<FRAME_IO_DEV_TOKEN>";

// Our root_asset_id = 4ecb383f-71a8-4233-b665-d8f75136f554
// You'll need to modify the following line to use your root asset ID.

var resp = new CkHttpResponse();
success = http.HttpJson("POST","https://api.frame.io/v2/assets/4ecb383f-71a8-4233-b665-d8f75136f554/children",json,"application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "team_id": "95a5fbad-688d-46fc-aef1-2f011dd76c10",
//   "public_item_count": 0,
//   "properties": null,
//   "deleted_at": null,
//   "fps": null,
//   "rating": null,
//   "description": null,
//   "updated_at": "2020-08-18T03:31:59.699011Z",
//   "cover_asset_id": null,
//   "archive_scheduled_at": null,
//   "subtitle_tracks": null,
//   "index": -7.0,
//   "item_count": 0,
//   "account_id": "b1cd046b-a3bf-4ef8-81a6-0afd74ecc455",
//   "name": "FolderA",
//   "checksums": null,
//   "audio_tracks": null,
//   "duration": null,
//   "label": "none",
//   "is_session_watermarked": false,
//   "parent_id": "4ecb383f-71a8-4233-b665-d8f75136f554",
//   "versions": 0,
//   "project_id": "e76653c4-6cc0-4c47-936b-f7885b477dc0",
//   "resource_id": null,
//   "private": false,
//   "frames": 0,
//   "autoversion_id": null,
//   "type": "folder",
//   "uploaded_at": "2020-08-18T03:31:59.697174Z",
//   "creator_id": "34b4f98a-7cc9-4159-8f46-c7c3d837fc6f",
//   "user_permissions": {
//     "can_download": true,
//     "can_modify_template": false,
//     "can_public_share_presentation": true,
//     "can_public_share_review_link": true,
//     "can_share_downloadable_presentation": true,
//     "can_share_downloadable_review_link": true,
//     "can_share_unwatermarked_presentation": true,
//     "can_share_unwatermarked_review_link": true
//   },
//   "shared": false,
//   "is_360": false,
//   "_type": "folder",
//   "comment_count": 0,
//   "archived_at": null,
//   "filetype": null,
//   "id": "039845e8-bffe-4d6b-88d3-c780bae06342",
//   "hard_deleted_at": null,
//   "copy": false,
//   "is_hls_required": false,
//   "archive_status": null,
//   "inserted_at": "2020-08-18T03:31:59.699011Z",
//   "filesize": 0
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

var team_id = jResp.StringOf("team_id");
var public_item_count = jResp.IntOf("public_item_count");
var properties = jResp.StringOf("properties");
var deleted_at = jResp.StringOf("deleted_at");
var fps = jResp.StringOf("fps");
var rating = jResp.StringOf("rating");
var description = jResp.StringOf("description");
var updated_at = jResp.StringOf("updated_at");
var cover_asset_id = jResp.StringOf("cover_asset_id");
var archive_scheduled_at = jResp.StringOf("archive_scheduled_at");
var subtitle_tracks = jResp.StringOf("subtitle_tracks");
var index = jResp.StringOf("index");
var item_count = jResp.IntOf("item_count");
var account_id = jResp.StringOf("account_id");
var name = jResp.StringOf("name");
var checksums = jResp.StringOf("checksums");
var audio_tracks = jResp.StringOf("audio_tracks");
var duration = jResp.StringOf("duration");
var label = jResp.StringOf("label");
var is_session_watermarked = jResp.BoolOf("is_session_watermarked");
var parent_id = jResp.StringOf("parent_id");
var versions = jResp.IntOf("versions");
var project_id = jResp.StringOf("project_id");
var resource_id = jResp.StringOf("resource_id");
var v_private = jResp.BoolOf("private");
var frames = jResp.IntOf("frames");
var autoversion_id = jResp.StringOf("autoversion_id");
var v_type = jResp.StringOf("type");
var uploaded_at = jResp.StringOf("uploaded_at");
var creator_id = jResp.StringOf("creator_id");
var user_permissionsCan_download = jResp.BoolOf("user_permissions.can_download");
var user_permissionsCan_modify_template = jResp.BoolOf("user_permissions.can_modify_template");
var user_permissionsCan_public_share_presentation = jResp.BoolOf("user_permissions.can_public_share_presentation");
var user_permissionsCan_public_share_review_link = jResp.BoolOf("user_permissions.can_public_share_review_link");
var user_permissionsCan_share_downloadable_presentation = jResp.BoolOf("user_permissions.can_share_downloadable_presentation");
var user_permissionsCan_share_downloadable_review_link = jResp.BoolOf("user_permissions.can_share_downloadable_review_link");
var user_permissionsCan_share_unwatermarked_presentation = jResp.BoolOf("user_permissions.can_share_unwatermarked_presentation");
var user_permissionsCan_share_unwatermarked_review_link = jResp.BoolOf("user_permissions.can_share_unwatermarked_review_link");
var shared = jResp.BoolOf("shared");
var is_360 = jResp.BoolOf("is_360");
v_type = jResp.StringOf("_type");
var comment_count = jResp.IntOf("comment_count");
var archived_at = jResp.StringOf("archived_at");
var filetype = jResp.StringOf("filetype");
var id = jResp.StringOf("id");
var hard_deleted_at = jResp.StringOf("hard_deleted_at");
var copy = jResp.BoolOf("copy");
var is_hls_required = jResp.BoolOf("is_hls_required");
var archive_status = jResp.StringOf("archive_status");
var inserted_at = jResp.StringOf("inserted_at");
var filesize = jResp.IntOf("filesize");