DataFlex Box: Copy Folder

Back to Index

Used to create a copy of a folder in another folder. The original version of the folder will not be altered. The a response status code of 202 is expected for success.

Documentation: https://developer.box.com/reference#copy-a-folder

CURL Command

curl https://api.box.com/2.0/folders/FOLDER_ID/copy \
-H "Authorization: Bearer BOX_ACCESS_TOKEN" \
-d '{"parent": {"id" : DESTINATION_FOLDER_ID}}' \
-X POST

DataFlex Example

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoRest
    Boolean iSuccess
    Boolean iBTls
    Integer iPort
    Boolean iBAutoReconnect
    Handle hoJson
    Variant vSbRequestBody
    Handle hoSbRequestBody
    Variant vSbResponseBody
    Handle hoSbResponseBody
Response    Handle hoJsonResponse
    String sType
    String sId
    String sSequence_id
    String sEtag
    String sName
    String sCreated_at
    String sModified_at
    String sDescription
    Integer iSize
    Integer iPath_collectionTotal_count
    String sCreated_byType
    String sCreated_byId
    String sCreated_byName
    String sCreated_byLogin
    String sModified_byType
    String sModified_byId
    String sModified_byName
    String sModified_byLogin
    String sOwned_byType
    String sOwned_byId
    String sOwned_byName
    String sOwned_byLogin
    String sShared_linkUrl
    Boolean iShared_linkDownload_url
    Boolean iShared_linkVanity_url
    Boolean iShared_linkIs_password_enabled
    Boolean iShared_linkUnshared_at
    Integer iShared_linkDownload_count
    Integer iShared_linkPreview_count
    String sShared_linkAccess
    Boolean iShared_linkPermissionsCan_download
    Boolean iShared_linkPermissionsCan_preview
    String sFolder_upload_emailAccess
    String sFolder_upload_emailEmail
    String sParentType
    String sParentId
    Boolean iParentSequence_id
    Boolean iParentEtag
    String sParentName
    String sItem_status
    Integer iItem_collectionTotal_count
    Integer iItem_collectionOffset
    Integer iItem_collectionLimit
    Integer i
    Integer iCount_i
    Boolean iSequence_id_bool
    Boolean iEtag_bool
    String sSha1
    String sTemp1
    Integer iTemp1

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    //  URL: https://api.box.com/2.0/folders/FOLDER_ID/copy
    Move True To iBTls
    Move 443 To iPort
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "api.box.com" iPort iBTls iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComConnectFailReason Of hoRest To iTemp1
        Showln "ConnectFailReason: " iTemp1
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateNumber Of hoJson "parent.id" "DESTINATION_FOLDER_ID" To iSuccess

    Get ComAddHeader Of hoRest "Authorization" "Bearer BOX_ACCESS_TOKEN" To iSuccess

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
    If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
        Send CreateComObject of hoSbRequestBody
    End
    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComFullRequestSb Of hoRest "POST" "/2.0/folders/FOLDER_ID/copy" vSbRequestBody vSbResponseBody To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonResponse
    If (Not(IsComObjectCreated(hoJsonResponse))) Begin
        Send CreateComObject of hoJsonResponse
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJsonResponse vSbResponseBody To iSuccess

    Get ComStringOf Of hoJsonResponse "type" To sType
    Get ComStringOf Of hoJsonResponse "id" To sId
    Get ComStringOf Of hoJsonResponse "sequence_id" To sSequence_id
    Get ComStringOf Of hoJsonResponse "etag" To sEtag
    Get ComStringOf Of hoJsonResponse "name" To sName
    Get ComStringOf Of hoJsonResponse "created_at" To sCreated_at
    Get ComStringOf Of hoJsonResponse "modified_at" To sModified_at
    Get ComStringOf Of hoJsonResponse "description" To sDescription
    Get ComIntOf Of hoJsonResponse "size" To iSize
    Get ComIntOf Of hoJsonResponse "path_collection.total_count" To iPath_collectionTotal_count
    Get ComStringOf Of hoJsonResponse "created_by.type" To sCreated_byType
    Get ComStringOf Of hoJsonResponse "created_by.id" To sCreated_byId
    Get ComStringOf Of hoJsonResponse "created_by.name" To sCreated_byName
    Get ComStringOf Of hoJsonResponse "created_by.login" To sCreated_byLogin
    Get ComStringOf Of hoJsonResponse "modified_by.type" To sModified_byType
    Get ComStringOf Of hoJsonResponse "modified_by.id" To sModified_byId
    Get ComStringOf Of hoJsonResponse "modified_by.name" To sModified_byName
    Get ComStringOf Of hoJsonResponse "modified_by.login" To sModified_byLogin
    Get ComStringOf Of hoJsonResponse "owned_by.type" To sOwned_byType
    Get ComStringOf Of hoJsonResponse "owned_by.id" To sOwned_byId
    Get ComStringOf Of hoJsonResponse "owned_by.name" To sOwned_byName
    Get ComStringOf Of hoJsonResponse "owned_by.login" To sOwned_byLogin
    Get ComStringOf Of hoJsonResponse "shared_link.url" To sShared_linkUrl
    Get ComIsNullOf Of hoJsonResponse "shared_link.download_url" To iShared_linkDownload_url
    Get ComIsNullOf Of hoJsonResponse "shared_link.vanity_url" To iShared_linkVanity_url
    Get ComBoolOf Of hoJsonResponse "shared_link.is_password_enabled" To iShared_linkIs_password_enabled
    Get ComIsNullOf Of hoJsonResponse "shared_link.unshared_at" To iShared_linkUnshared_at
    Get ComIntOf Of hoJsonResponse "shared_link.download_count" To iShared_linkDownload_count
    Get ComIntOf Of hoJsonResponse "shared_link.preview_count" To iShared_linkPreview_count
    Get ComStringOf Of hoJsonResponse "shared_link.access" To sShared_linkAccess
    Get ComBoolOf Of hoJsonResponse "shared_link.permissions.can_download" To iShared_linkPermissionsCan_download
    Get ComBoolOf Of hoJsonResponse "shared_link.permissions.can_preview" To iShared_linkPermissionsCan_preview
    Get ComStringOf Of hoJsonResponse "folder_upload_email.access" To sFolder_upload_emailAccess
    Get ComStringOf Of hoJsonResponse "folder_upload_email.email" To sFolder_upload_emailEmail
    Get ComStringOf Of hoJsonResponse "parent.type" To sParentType
    Get ComStringOf Of hoJsonResponse "parent.id" To sParentId
    Get ComIsNullOf Of hoJsonResponse "parent.sequence_id" To iParentSequence_id
    Get ComIsNullOf Of hoJsonResponse "parent.etag" To iParentEtag
    Get ComStringOf Of hoJsonResponse "parent.name" To sParentName
    Get ComStringOf Of hoJsonResponse "item_status" To sItem_status
    Get ComIntOf Of hoJsonResponse "item_collection.total_count" To iItem_collectionTotal_count
    Get ComIntOf Of hoJsonResponse "item_collection.offset" To iItem_collectionOffset
    Get ComIntOf Of hoJsonResponse "item_collection.limit" To iItem_collectionLimit
    Move 0 To i
    Get ComSizeOfArray Of hoJsonResponse "path_collection.entries" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJsonResponse To i
        Get ComStringOf Of hoJsonResponse "path_collection.entries[i].type" To sType
        Get ComStringOf Of hoJsonResponse "path_collection.entries[i].id" To sId
        Get ComIsNullOf Of hoJsonResponse "path_collection.entries[i].sequence_id" To iSequence_id_bool
        Get ComIsNullOf Of hoJsonResponse "path_collection.entries[i].etag" To iEtag_bool
        Get ComStringOf Of hoJsonResponse "path_collection.entries[i].name" To sName
        Move i + 1 To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJsonResponse "item_collection.entries" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJsonResponse To i
        Get ComStringOf Of hoJsonResponse "item_collection.entries[i].type" To sType
        Get ComStringOf Of hoJsonResponse "item_collection.entries[i].id" To sId
        Get ComStringOf Of hoJsonResponse "item_collection.entries[i].sequence_id" To sSequence_id
        Get ComStringOf Of hoJsonResponse "item_collection.entries[i].etag" To sEtag
        Get ComStringOf Of hoJsonResponse "item_collection.entries[i].sha1" To sSha1
        Get ComStringOf Of hoJsonResponse "item_collection.entries[i].name" To sName
        Move i + 1 To i
    Loop



End_Procedure

Sample JSON Response Body

{
  "type": "folder",
  "id": "11446498",
  "sequence_id": "1",
  "etag": "1",
  "name": "Pictures",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T11:15:04-08:00",
  "description": "Some pictures I took",
  "size": 629644,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "folder",
        "id": "0",
        "sequence_id": null,
        "etag": null,
        "name": "All Files"
      }
    ]
  },
  "created_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "modified_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "owned_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "shared_link": {
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "download_url": null,
    "vanity_url": null,
    "is_password_enabled": false,
    "unshared_at": null,
    "download_count": 0,
    "preview_count": 0,
    "access": "open",
    "permissions": {
      "can_download": true,
      "can_preview": true
    }
  },
  "folder_upload_email": {
    "access": "open",
    "email": "upload.Picture.k13sdz1@u.box.com"
  },
  "parent": {
    "type": "folder",
    "id": "0",
    "sequence_id": null,
    "etag": null,
    "name": "All Files"
  },
  "item_status": "active",
  "item_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "file",
        "id": "5000948880",
        "sequence_id": "3",
        "etag": "3",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
        "name": "tigers.jpeg"
      }
    ],
    "offset": 0,
    "limit": 100
  }
}