{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Move multiple files or folders","type":"basic","slug":"move-multiple-files-or-folders","excerpt":"","body":"This call lets you perform a bulk move operation of files and folders. You can move files or folders:\n\n* to a root project folder \n* to a subfolder within the same project or a different project\n\n##Rules for moving files and folders\n\n* The file ID is preserved after the move.\n* The folder ID is changed after the move.\n* The destination has to be an existing folder. \n* If the target folder contains a folder with the same name, the contents of both folders will be merged.\n* If a file with the same name already exists, the source file will be automatically renamed (by adding a numeric prefix).  \n* You need to have WRITE permissions for both the source and destination folders. \n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https:/cgc-api.sbgenomics.com/v2/async/files/move\",\n      \"language\": \"text\",\n      \"name\": \"Path  \"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/async/files/move\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5336ea8f1273259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://cgc-api.sbgenomics.com/v2/async/files/copy \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SBG-Auth-Token: d32c2976ffc04d0eb90c6c4fb2c0a465' \\\\\\n  -H 'af055f57c30a3e2d99c1fd42101f13da: ' \\\\\\n  -d '{\\n  \\\"items\\\": [\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b038563238932f\\\",\\n      \\\"parent\\\": \\\"5c6d3f30e4b038533235932f\\\",\\n      \\\"project\\\": \\\"\\\",\\n      \\\"name\\\": \\\"my-new-file\\\"\\n    },\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b038563238932b\\\",\\n      \\\"parent\\\": \\\"\\\",\\n      \\\"project\\\": \\\"rfranklin/destination-project\\\",\\n      \\\"name\\\": \\\"\\\"\\n    },\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b0385632389331\\\",\\n      \\\"parent\\\": \\\"\\\",\\n      \\\"project\\\": \\\"rfranklin/destination-project\\\",\\n      \\\"name\\\": \\\"\\\"\\n    }\\n  ]\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \" X-SBG-Auth-Token\\n*required* \",\n    \"0-1\": \"Your CGC [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \" Content-Type\\n*required* \",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Request body\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`file`\\nrequired\",\n    \"0-1\": \"object\",\n    \"0-2\": \"The ID of the file or folder you are moving. \\n\\nUse the API call for listing all files or folders to obtain the ID.\",\n    \"1-0\": \"`parent`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"The ID of the folder you are moving files to.\",\n    \"2-0\": \"`name`\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Enter the new name for the file or folder if you want to rename it in the destination folder.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"items\\\": [\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b038563238932f\\\",\\n      \\\"parent\\\": \\\"5c6d3f30e4b038533235932f\\\",\\n      \\\"project\\\": \\\"\\\",\\n      \\\"name\\\": \\\"my-new-file\\\"\\n    },\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b038563238932b\\\",\\n      \\\"parent\\\": \\\"2c6d3b10e4b038533235932g\\\",\\n      \\\"name\\\": \\\"\\\"\\n    },\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b0385632389331\\\",\\n      \\\"parent\\\": \\\"85c6d3f30e4b038533235932h\\\",\\n      \\\"name\\\": \\\"\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example request body\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\n[See a list of specific response codes that may be contained in the body of the response](ref:api-status-codes).\n[block:api-header]\n{\n  \"title\": \"Response body\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`type`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The type of job, which is `MOVE` in the case of copying files.\",\n    \"1-0\": \"`total_files`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"The total number of files which will be processed. You can obtain this information using the call for getting the details of a move job.\",\n    \"2-0\": \"`state`\",\n    \"2-1\": \"string\",\n    \"2-2\": \"The state is `SUBMITTED` at the time of making this call.\",\n    \"3-0\": \"`result`\",\n    \"3-1\": \"string\",\n    \"3-2\": \"This key will show the result if available at the time the call is made. Use the details of a move job to see more information.\",\n    \"4-0\": \"`id`\",\n    \"4-1\": \"string\",\n    \"4-2\": \"ID of this move job.\",\n    \"5-0\": \"`failed_files`\",\n    \"5-1\": \"string\",\n    \"5-2\": \"The number of failed files if that information is available at the time of the call. You can get details of a move job with a dedicated call.\",\n    \"6-0\": \"`completed_files`\",\n    \"6-1\": \"string\",\n    \"6-2\": \"The number of completed files if that information is available at the time of the call. You can get details of a move job with a dedicated call.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example response body\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/async/files/move/70714077692891136\\\",\\n    \\\"id\\\": \\\"70714077692891136\\\",\\n    \\\"result\\\": [],\\n    \\\"type\\\": \\\"MOVE\\\",\\n    \\\"state\\\": \\\"SUBMITTED\\\",\\n    \\\"failed_files\\\": 0,\\n    \\\"completed_files\\\": 0,\\n    \\\"total_files\\\": 0\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5df396ae72b26f006edeab78","project":"55faf11ba62ba1170021a9a7","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":46},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"ASYNC BULK ACTIONS","slug":"async-bulk-actions","order":37,"from_sync":false,"reference":false,"_id":"5c8a525e2ba7b2003f9b153c","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","createdAt":"2019-03-14T13:08:46.350Z","__v":0},"user":"566590c83889610d0008a253","createdAt":"2019-12-13T13:48:30.846Z","__v":0,"parentDoc":null}

GET STARTED

TUTORIALS

ACCESS THE CGC

MANAGE AN ANALYSIS ENVIRONMENT

COLLABORATE SECURELY

DATASETS HUB

PUBLIC PROJECTS

BRING DATA TO THE CGC

SET METADATA ASSOCIATED WITH A PRIVATE FILE

SEARCH FILES

ADD FILES TO A PROJECT

ORGANIZE FILES

ARCHIVE FILES

FIND APPS

BRING YOUR TOOLS

DOCKER

DESCRIBE YOUR TOOL (LEGACY)

TOOL WRAPPING TIPS AND TRICKS

EDIT AN APP (LEGACY)

ARCHIVE APPS

RUN AN ANALYSIS

TASK EXECUTION

REVIEW A TASK

VIEW ANALYSIS RESULTS

INTERACTIVE ANALYSIS

DOWNLOAD RESULTS

DEVELOPER TOOLS

CONNECT CLOUD STORAGE

API Hub

API CLIENTS

SB Command Line Interface

API Reference

EDIT AN APP

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WATCH AND LEARN

DATA CRUNCHER

SBFS (Beta)

SBFS Command Reference

Move multiple files or folders

This call lets you perform a bulk move operation of files and folders. You can move files or folders: * to a root project folder * to a subfolder within the same project or a different project ##Rules for moving files and folders * The file ID is preserved after the move. * The folder ID is changed after the move. * The destination has to be an existing folder. * If the target folder contains a folder with the same name, the contents of both folders will be merged. * If a file with the same name already exists, the source file will be automatically renamed (by adding a numeric prefix). * You need to have WRITE permissions for both the source and destination folders. [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https:/cgc-api.sbgenomics.com/v2/async/files/move", "language": "text", "name": "Path " } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "POST /v2/async/files/move\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5336ea8f1273259740f75", "language": "http", "name": null }, { "code": "curl -X POST \\\n https://cgc-api.sbgenomics.com/v2/async/files/copy \\\n -H 'Content-Type: application/json' \\\n -H 'X-SBG-Auth-Token: d32c2976ffc04d0eb90c6c4fb2c0a465' \\\n -H 'af055f57c30a3e2d99c1fd42101f13da: ' \\\n -d '{\n \"items\": [\n {\n \"file\": \"5c6d3f30e4b038563238932f\",\n \"parent\": \"5c6d3f30e4b038533235932f\",\n \"project\": \"\",\n \"name\": \"my-new-file\"\n },\n {\n \"file\": \"5c6d3f30e4b038563238932b\",\n \"parent\": \"\",\n \"project\": \"rfranklin/destination-project\",\n \"name\": \"\"\n },\n {\n \"file\": \"5c6d3f30e4b0385632389331\",\n \"parent\": \"\",\n \"project\": \"rfranklin/destination-project\",\n \"name\": \"\"\n }\n ]\n}'", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": " X-SBG-Auth-Token\n*required* ", "0-1": "Your CGC [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": " Content-Type\n*required* ", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ###Request body [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`file`\nrequired", "0-1": "object", "0-2": "The ID of the file or folder you are moving. \n\nUse the API call for listing all files or folders to obtain the ID.", "1-0": "`parent`", "1-1": "string", "1-2": "The ID of the folder you are moving files to.", "2-0": "`name`", "2-1": "string", "2-2": "Enter the new name for the file or folder if you want to rename it in the destination folder." }, "cols": 3, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"file\": \"5c6d3f30e4b038563238932f\",\n \"parent\": \"5c6d3f30e4b038533235932f\",\n \"project\": \"\",\n \"name\": \"my-new-file\"\n },\n {\n \"file\": \"5c6d3f30e4b038563238932b\",\n \"parent\": \"2c6d3b10e4b038533235932g\",\n \"name\": \"\"\n },\n {\n \"file\": \"5c6d3f30e4b0385632389331\",\n \"parent\": \"85c6d3f30e4b038533235932h\",\n \"name\": \"\"\n }\n ]\n}", "language": "json", "name": "Example request body" } ] } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [See a list of specific response codes that may be contained in the body of the response](ref:api-status-codes). [block:api-header] { "title": "Response body" } [/block] [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`type`", "0-1": "string", "0-2": "The type of job, which is `MOVE` in the case of copying files.", "1-0": "`total_files`", "1-1": "string", "1-2": "The total number of files which will be processed. You can obtain this information using the call for getting the details of a move job.", "2-0": "`state`", "2-1": "string", "2-2": "The state is `SUBMITTED` at the time of making this call.", "3-0": "`result`", "3-1": "string", "3-2": "This key will show the result if available at the time the call is made. Use the details of a move job to see more information.", "4-0": "`id`", "4-1": "string", "4-2": "ID of this move job.", "5-0": "`failed_files`", "5-1": "string", "5-2": "The number of failed files if that information is available at the time of the call. You can get details of a move job with a dedicated call.", "6-0": "`completed_files`", "6-1": "string", "6-2": "The number of completed files if that information is available at the time of the call. You can get details of a move job with a dedicated call." }, "cols": 3, "rows": 7 } [/block] [block:api-header] { "type": "basic", "title": "Example response body", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cgc-api.sbgenomics.com/v2/async/files/move/70714077692891136\",\n \"id\": \"70714077692891136\",\n \"result\": [],\n \"type\": \"MOVE\",\n \"state\": \"SUBMITTED\",\n \"failed_files\": 0,\n \"completed_files\": 0,\n \"total_files\": 0\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]