{"_id":"5b0e13ffc4664e0003c75bc8","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"},"__v":0,"user":"554340dfb7f4540d00fcef1d","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"},"project":"5b0e13ffc4664e0003c75a66","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":["56a5eeb52d58cf0d00164bc7"],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T13:04:53.167Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":103,"body":"This call allows you to get the ID for a file, which you can then use to perform operations on that particular file, or to request more information about it.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/action/files/get_ids\",\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/action/files/get_ids HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '[\\\"/Datasets/tcga/TCGA-LUAD/ac0d7a82-82cb-4aec-b859-e37375f3de8b/analysis/1e849d63-a360-4d35-b9fe-745a3f0bf291/data/C509.TCGA-97-8547-01A-11D-2393-08.2.bam\\\"]' -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://f4c-api.sbgenomics.com/v2/action/files/get_ids\\\"\\n\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n##Request body\nIn the body, you should enter an array of strings, containing the file paths.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Body\",\n    \"h-1\": \"Data type of body\",\n    \"h-2\": \"Content of value\",\n    \"0-0\": \"array of strings, consisting of file paths.\",\n    \"0-1\": \"\",\n    \"0-2\": \"\"\n  },\n  \"cols\": 1,\n  \"rows\": 1\n}\n[/block]\n\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    \\\"564a5a59e4b08c5d8694e32a\\\"\\n]\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nNote that if you submit an incorrect file path, the call will return the value `null`. Also, the resulting array will have the same order of elements as in the request.","excerpt":"/v2/action/files/get_ids","slug":"get-file-ids","type":"endpoint","title":"Get file IDs"}

postGet file IDs

/v2/action/files/get_ids

This call allows you to get the ID for a file, which you can then use to perform operations on that particular file, or to request more information about it. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/action/files/get_ids", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/action/files/get_ids HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96", "language": "http", "name": null }, { "code": "curl --data '[\"/Datasets/tcga/TCGA-LUAD/ac0d7a82-82cb-4aec-b859-e37375f3de8b/analysis/1e849d63-a360-4d35-b9fe-745a3f0bf291/data/C509.TCGA-97-8547-01A-11D-2393-08.2.bam\"]' -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X POST \"https://f4c-api.sbgenomics.com/v2/action/files/get_ids\"\n", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ##Request body In the body, you should enter an array of strings, containing the file paths. [block:parameters] { "data": { "h-0": "Body", "h-1": "Data type of body", "h-2": "Content of value", "0-0": "array of strings, consisting of file paths.", "0-1": "", "0-2": "" }, "cols": 1, "rows": 1 } [/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 \"564a5a59e4b08c5d8694e32a\"\n]", "language": "json" } ], "sidebar": true } [/block] Note that if you submit an incorrect file path, the call will return the value `null`. Also, the resulting array will have the same order of elements as in the request.