{"_id":"58207c74775f3a1b00a46085","githubsync":"","version":{"_id":"5773dcfc255e820e00e1cd50","__v":27,"project":"5773dcfc255e820e00e1cd4d","createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"581c8d55c0dc651900aa9350","__v":0,"project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-04T13:29:57.267Z","from_sync":false,"order":18,"slug":"cavatica-datasets-api-advanced-access","title":"CAVATICA DATASETS API (Advanced Access)"},"parentDoc":null,"project":"5773dcfc255e820e00e1cd4d","user":"566590c83889610d0008a253","__v":0,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-07T13:07:00.826Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"patch","results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"`/datasets/{owner}/{dataset}`\n[block:callout]\n{\n \"type\": \"danger\",\n \"title\": \"Heads Up!\",\n \"body\": \"This page documents the Advanced Access version (think \\\"beta\\\" but with fewer bugs) of the Datasets API functionality.\"\n}\n[/block]\nThis call edits a dataset. You can use it to change the dataset name and description.\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"https://cavatica-api.sbgenomics.com/v2/datasets/{owner}/{dataset}\",\n \"language\": \"http\",\n \"name\": \"API path\"\n }\n ]\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"If your client does not support PATCH requests, you can use POST to send this request, along with the query parameter `_method=PATCH`, e.g:\\n\\nhttps://cavatica-api.sbgenomics.com/v2/datasets/{owner}/{dataset}?_method=PATCH\"\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"PATCH /v2/datasets/rfranklin/pnoc-dipg-pa-02\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\\nX-SBG-advance-access: advance\",\n \"language\": \"http\",\n \"name\": \"HTTP\"\n },\n {\n \"code\": \"curl -X PATCH -H \\\"X-SBG-Auth-Token: 5f2d7a4d8186488694fa3dc3844b7b06\\\" -H \\\"x-sbg-advance-access: advance\\\" -H \\\"Content-Type: application/json\\\" -d '{\\n \\\"name\\\": \\\"New name for my dataset\\\",\\n \\\"description\\\" : \\\"New description for my dataset\\\"\\n}' \\\"https://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pnoc-dipg-pa-02\\\"\",\n \"language\": \"curl\",\n \"name\": \"cURL\"\n }\n ]\n}\n[/block]\n##Request body\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\": \"`name`\",\n \"0-1\": \"string\",\n \"0-2\": \"Enter the new name for your dataset.\",\n \"1-0\": \"`description`\",\n \"1-1\": \"string\",\n \"1-2\": \"Enter the new description for your dataset.\"\n },\n \"cols\": 3,\n \"rows\": 2\n}\n[/block]\n###Example request body\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"name\\\" : \\\"New name for my dataset\\\",\\n \\\"description\\\" : \\\"New description for my dataset\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"Example request body\"\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\",\n \"0-1\": \"Your Cavatica authentication token.\",\n \"1-0\": \"`X-SBG-Advance-Access`\\n*required*\",\n \"1-1\": \"`advance`\"\n },\n \"cols\": 2,\n \"rows\": 2\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Name\",\n \"h-1\": \"Description\",\n \"0-0\": \"`owner`\",\n \"0-1\": \"The owner of the dataset you are editing.\",\n \"1-0\": \"`dataset`\",\n \"1-1\": \"The name of the dataset you are editing.\"\n },\n \"cols\": 2,\n \"rows\": 2\n}\n[/block]\n##Response\n[See a list of Cavatica-specific response codes that may be contained in the body of the response.\n](doc:api-status-codes).\n\n###Example response body\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"href\\\": \\\"http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pnoc-dipg-pa-02\\\",\\n \\\"id\\\": \\\"rfranklin/pnoc-dipg-pa-02\\\",\\n \\\"name\\\": \\\"New name for my dataset\\\",\\n \\\"description\\\": \\\"New description form my dataset\\\"\\n} \",\n \"language\": \"json\",\n \"name\": \"Example response body\"\n }\n ]\n}\n[/block]","excerpt":"","slug":"edit-a-dataset","type":"endpoint","title":"Edit a dataset"}