{"_id":"5b0e13ffc4664e0003c75b32","category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"project":"5b0e13ffc4664e0003c75a66","user":"554340dfb7f4540d00fcef1d","__v":0,"parentDoc":null,"version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":["566b22e247ebaf1900fe666e","567338f5f79ca90d00ad2e89"],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:19:20.262Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":40,"body":"This call allows you to copy a list of files at a time between projects.\n\nFiles are specified by their IDs, which you can obtain by making the API call to [list all files accessible to you](list-files-in-a-project).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/files/copy\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/files/copy HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '{\\\"project\\\": \\\"RFranklin/my-project\\\", \\\"files\\\": [\\\"56534e57e4b093830b6e9681\\\", \\\"560567b8e4b00cd40d0c9236\\\", \\\"56056792e4b092bac639b84e\\\"]}' -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://f4c-api.sbgenomics.com/v2/files/copy\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n#Request body\n\nIn the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table. See also the example request body on the right.\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\": \"`project_ID`\",\n    \"1-0\": \"`files`\",\n    \"0-2\": \"The ID of the project you want to copy into.\",\n    \"1-2\": \"An array of IDs for the files you want to copy.\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"files\\\": [\\n    \\\"56534e57e4b093830b6e9681\\\",\\n    \\\"560567b8e4b00cd40d0c9236\\\",\\n    \\\"56056792e4b092bac639b84e\\\"\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"File IDs\",\n  \"body\": \"Note that file IDs are dependent on the projects that they are in. When you copy a file to a different project, its ID changes.\"\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 [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"56028d95e4b0be2f1afae512\\\" : {\\n      \\\"status\\\": \\\"OK\\\",\\n      \\\"new_file_id\\\": \\\"52d69fc0e4b0a77ec4fd2079\\\"\\n    },\\n    \\\"560567b8e4b00cd40d0c9236\\\" : {\\n      \\\"status\\\": \\\"OK\\\",\\n      \\\"new_file_id\\\": \\\"52d69fbde4b0a77ec4fb8738\\\"\\n    },\\n    \\\"56056792e4b092bac639b84e\\\" : {\\n      \\\"status\\\": \\\"OK\\\",\\n      \\\"new_file_id\\\": \\\"55b89899e4b091df2925371e\\\"\\n\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": null\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/files/copy","slug":"copy-files-between-projects","type":"endpoint","title":"Copy files between projects"}

postCopy files between projects

/files/copy

This call allows you to copy a list of files at a time between projects. Files are specified by their IDs, which you can obtain by making the API call to [list all files accessible to you](list-files-in-a-project). [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/files/copy", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/files/copy HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl --data '{\"project\": \"RFranklin/my-project\", \"files\": [\"56534e57e4b093830b6e9681\", \"560567b8e4b00cd40d0c9236\", \"56056792e4b092bac639b84e\"]}' -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X POST \"https://f4c-api.sbgenomics.com/v2/files/copy\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] #Request body In the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table. See also the example request body on the right. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`project_ID`", "1-0": "`files`", "0-2": "The ID of the project you want to copy into.", "1-2": "An array of IDs for the files you want to copy.", "0-1": "string", "1-1": "string" }, "cols": 3, "rows": 2 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n \"project\": \"RFranklin/my-project\",\n \"files\": [\n \"56534e57e4b093830b6e9681\",\n \"560567b8e4b00cd40d0c9236\",\n \"56056792e4b092bac639b84e\"\n ]\n}", "language": "json" } ], "sidebar": true } [/block] [block:callout] { "type": "success", "title": "File IDs", "body": "Note that file IDs are dependent on the projects that they are in. When you copy a file to a different project, its ID changes." } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"56028d95e4b0be2f1afae512\" : {\n \"status\": \"OK\",\n \"new_file_id\": \"52d69fc0e4b0a77ec4fd2079\"\n },\n \"560567b8e4b00cd40d0c9236\" : {\n \"status\": \"OK\",\n \"new_file_id\": \"52d69fbde4b0a77ec4fb8738\"\n },\n \"56056792e4b092bac639b84e\" : {\n \"status\": \"OK\",\n \"new_file_id\": \"55b89899e4b091df2925371e\"\n\n }\n}", "language": "json", "name": null } ], "sidebar": true } [/block]