Copy multiple files

This call lets you perform a bulk copy operation of files and folders. Any underlying folder structure will be preserved. You can copy: * to a folder within the same project * to another project * to a folder in another project [block:api-header] { "type": "basiac", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/async/files/copy\n", "language": "text", "name": "Path" } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "POST /v2/async/files/copy\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 copying. Use the API call for listing all files to obtain the ID.", "1-0": "`parent`", "1-1": "string", "1-2": "The ID of the folder you are copying files to. The `parent` and `project` keys are mutually exclusive. If you are copying files to a folder, omit the `project` key.", "2-0": "`project`", "2-1": "string", "2-2": "The name of the project you are copying files to. The `project` and `parent` keys are mutually exclusive. if you are copying files to the root folder of your project, omit the `parent` key.", "3-0": "`name`", "3-1": "string", "3-2": "Enter the new name for the file if you want to rename it in the destination folder." }, "cols": 3, "rows": 4 } [/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\": \"\",\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": "json", "name": "Example request body" } ] } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [See a list of CGC-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 `COPY` 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 copy 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 copy job to see more information.", "4-0": "`id`", "4-1": "string", "4-2": "ID of this copy 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 copy 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 copy 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/copy/70714077692891136\",\n \"id\": \"70714077692891136\",\n \"result\": [],\n \"type\": \"COPY\",\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]

GET STARTED

TUTORIALS

ACCESS THE CGC

MANAGE AN ANALYSIS ENVIRONMENT

COLLABORATE SECURELY

DATASETS HUB

PUBLIC PROJECTS

BRING YOUR PRIVATE DATA

SET METADATA ASSOCIATED WITH A PRIVATE FILE

SEARCH FILES

ADD FILES TO A PROJECT

ORGANIZE FILES

ARCHIVE FILES

FIND APPS

RABIX OVERVIEW

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

WATCH AND LEARN

DATA CRUNCHER

SBFS (Beta)

SBFS Command Reference