{"_id":"5b0e13ffc4664e0003c75b0e","project":"5b0e13ffc4664e0003c75a66","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"},"category":{"_id":"5b0e13ffc4664e0003c75ab1","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-04-17T10:59:30.322Z","from_sync":false,"order":35,"slug":"bulk-actions","title":"BULK API ACTIONS"},"user":"566590c83889610d0008a253","__v":0,"githubsync":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-17T11:47:11.080Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"Delete files in bulk by specifying their IDs.\n\n##Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/bulk/files/delete\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request body\n\nIn the request body, enter the IDs of the files you want to delete.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`file_ids`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The ids of the file you are deleting. Separate file IDs with a comma.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/bulk/files/delete HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://f4c-api.sbgenomics.com/v2/bulk/files/delete \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74' \\\\\\n  -d '{\\n    \\\"file_ids\\\" : [\\\"5a97d4741c94edbe85904909\\\", \\\"5a97d4741c94edbe8590493b\\\"]\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ]\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    \"1-0\": \" Content-Type\\n*required* \",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response.](ref:api-status-codes).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"items\\\": [\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/5a97d4741c94edbe85904936\\\",\\n                \\\"id\\\": \\\"5a97d4741c94edbe85904909\\\",\\n                \\\"name\\\": \\\"1000G_phase1.snps.high_confidence.b37.vcf\\\",\\n                \\\"size\\\": 7313069069,\\n                \\\"project\\\": \\\"rfranklin/my-projects\\\",\\n                \\\"created_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n                \\\"modified_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n                \\\"storage\\\": {\\n                    \\\"type\\\": \\\"PLATFORM\\\"\\n                },\\n                \\\"origin\\\": {},\\n                \\\"tags\\\": [],\\n                \\\"metadata\\\": {}\\n            }\\n        },\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/5a97d4741c94edbe85904936\\\",\\n                \\\"id\\\": \\\"5a97d4741c94edbe8590493b\\\",\\n                \\\"name\\\": \\\"C835.HCC1143_BL.4.contig_1_mpileup_SNPs.filtered.Somatic.hc.and_more.concat.sorted.reordered.vcf\\\",\\n                \\\"size\\\": 7313069069,\\n                \\\"project\\\": \\\"rfranklin/my-projects\\\",\\n                \\\"created_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n                \\\"modified_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n                \\\"storage\\\": {\\n                    \\\"type\\\": \\\"PLATFORM\\\"\\n                },\\n                \\\"origin\\\": {},\\n                \\\"tags\\\": [],\\n                \\\"metadata\\\": {}\\n            }\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"bulk-deletion-of-files","type":"endpoint","title":"Bulk deletion of files"}

postBulk deletion of files


Delete files in bulk by specifying their IDs. ##Request [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/bulk/files/delete", "language": "text", "name": "Path" } ] } [/block] ##Request body In the request body, enter the IDs of the files you want to delete. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`file_ids`", "0-1": "string", "0-2": "The ids of the file you are deleting. Separate file IDs with a comma." }, "cols": 3, "rows": 1 } [/block] ###Example request [block:code] { "codes": [ { "code": "POST /v2/bulk/files/delete HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74", "language": "http", "name": "HTTP" }, { "code": "curl -X POST \\\n https://f4c-api.sbgenomics.com/v2/bulk/files/delete \\\n -H 'Content-Type: application/json' \\\n -H 'X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74' \\\n -d '{\n \"file_ids\" : [\"5a97d4741c94edbe85904909\", \"5a97d4741c94edbe8590493b\"]\n}'", "language": "curl", "name": "cURL" } ] } [/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": "", "1-0": " Content-Type\n*required* ", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](ref:api-status-codes). [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"resource\": {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/5a97d4741c94edbe85904936\",\n \"id\": \"5a97d4741c94edbe85904909\",\n \"name\": \"1000G_phase1.snps.high_confidence.b37.vcf\",\n \"size\": 7313069069,\n \"project\": \"rfranklin/my-projects\",\n \"created_on\": \"2018-03-01T10:22:44Z\",\n \"modified_on\": \"2018-03-01T10:22:44Z\",\n \"storage\": {\n \"type\": \"PLATFORM\"\n },\n \"origin\": {},\n \"tags\": [],\n \"metadata\": {}\n }\n },\n {\n \"resource\": {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/5a97d4741c94edbe85904936\",\n \"id\": \"5a97d4741c94edbe8590493b\",\n \"name\": \"C835.HCC1143_BL.4.contig_1_mpileup_SNPs.filtered.Somatic.hc.and_more.concat.sorted.reordered.vcf\",\n \"size\": 7313069069,\n \"project\": \"rfranklin/my-projects\",\n \"created_on\": \"2018-03-01T10:22:44Z\",\n \"modified_on\": \"2018-03-01T10:22:44Z\",\n \"storage\": {\n \"type\": \"PLATFORM\"\n },\n \"origin\": {},\n \"tags\": [],\n \"metadata\": {}\n }\n }\n ]\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]