Folder

Get Folder List

Get folder list identified by {binder_id}; the returned result shows files along with the folders hierarchy structure

GET /{binder_id}/folders

Sample Request
GET /BIAJqlZHXWMB6O4JI5fv6Q4/folders
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "files": [
            {
                "file_id": "650aee51-52f7-47df-89e8-5b7394179bbc",
                "name": "incoming.html",
                "created_time": 1435359926443,
                "updated_time": 1435360933608,
                "file_size": 23153
            },
            {
                "file_id": "7676930b-b71d-4f35-825d-84e7e4c01dc1",
                "name": "quickbooks.htm",
                "created_time": 1435362150028,
                "updated_time": 1435362151912,
                "file_size": 13754
            }
        ],
        "folders": [
            {
                "folder_id": 91,
                "name": "level1",
                "created_time": 1437514459629,
                "updated_time": 1437678306449,
                "files": [
                    {
                        "file_id": "78a91635-5f36-498e-8722-517124b9921e",
                        "name": "web_hooks.docx",
                        "created_time": 1437514509995,
                        "updated_time": 1437514538401,
                        "file_size": 3422690
                    }
                ],
                "folders": []
            },
            {
                "folder_id": 678,
                "name": "level1-1",
                "created_time": 1437676498091,
                "updated_time": 1437692636197,
                "files": [
                    {
                        "file_id": "b8485cbb-d780-4c83-8eec-2601cb98da5e",
                        "name": "mobile_apps.vsd",
                        "created_time": 1437692341585,
                        "updated_time": 1437692341585,
                        "file_size": 241643
                    },
                    {
                        "file_id": "3b5912a9-3558-4314-a8b1-4aabb940453d",
                        "name": "chat_spec.docx",
                        "created_time": 1437692384271,
                        "updated_time": 1437692394655,
                        "file_size": 745434
                    }
                ],
                "folders": [
                    {
                        "folder_id": 932,
                        "name": "level2",
                        "created_time": 1437692444327,
                        "updated_time": 1437692563155,
                        "files": [
                            {
                                "file_id": "15a99168-95d1-4a1b-a099-b8a8d237800e",
                                "name": "Moxtra API 2.0.docx",
                                "created_time": 1437692548675,
                                "updated_time": 1437692563155,
                                "file_size": 424254
                            }
                        ],
                        "folders": []
                    },
                    {
                        "folder_id": 981,
                        "name": "level2-1",
                        "created_time": 1437692566222,
                        "updated_time": 1437692636197,
                        "files": [
                            {
                                "file_id": "f692d935-c306-479e-bd76-65e773992e8d",
                                "name": "plants.docx",
                                "created_time": 1437692579014,
                                "updated_time": 1437692592331,
                                "file_size": 1234123
                            },
                            {
                                "file_id": "5cc430a3-7109-4148-b00c-21ab5482f73d",
                                "name": "Test_DNA.docx",
                                "created_time": 1437692626827,
                                "updated_time": 1437692636197,
                                "file_size": 9442221
                            }
                        ],
                        "folders": []
                    }
                ]
            }
        ]
    }    
}

Create Folder

Create a folder identified by {binder_id}.

POST /{binder_id}/folders

URL Parameters
Name Type Description
parent_folder_path String Optional: the parent folder path via folder_ids separated by comma(,); for example, "91,981".

JSON Parameters
Name Type Description
name String Name of the folder.
Sample Request
POST /B7V4ze37oO08PYO70973lX6/folders
{
    "name": "demo"
}
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "folders": [
            {
                "folder_id": 35,
                "name": "demo",
                "created_time": 1437514459629,
                "updated_time": 1437678306449
            }
        ]    
    }
}

Update Folder

Update a folder name identified by {binder_id} and {folder_id}.

POST /{binder_id}/folders/{folder_id}

URL Parameters
Name Type Description
parent_folder_path String Optional: the parent folder path via folder_ids separated by comma(,); for example, "91,981".

JSON Parameters
Name Type Description
name String Folder name.
Sample Request
POST /B7V4ze37oO08PYO70973lX6/folders/35
{
    "name": "Display"
}
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "folders": [
            {
                "folder_id": 35,
                "name": "Display",
                "created_time": 1437514459629,
                "updated_time": 1482951934542
            }
        ]    
    }
}

Delete Folder

Delete a folder identified by {binder_id} and {folder_id}.

DELETE /{binder_id}/folders/{folder_id}

URL Parameters
Name Type Description
parent_folder_path String Optional: the parent folder path via folder_ids separated by comma(,); for example, "91,981".

Sample Request
DELETE /B9rArkzRe094lPPiMH4UpS8/folders/35
Sample Response
{
    "code": "RESPONSE_SUCCESS"
}

Download Folder

Download the folder content as a zip file from the binder identified by {binder_id} and {folder_id}

GET /{binder_id}/folders/{folder_id}

URL Parameters
Name Type Description
parent_folder_path String Optional: the parent folder path via folder_ids separated by comma(,); for example, "91,981".

Sample Request
GET /B9rArkzRe094lPPiMH4UpS8/folders/35
Sample Response
#folder_name.zip file