{"_id":"5845ab539f6fbb1b0043085a","project":"55faf11ba62ba1170021a9a7","__v":0,"user":"5613e4f8fdd08f2b00437620","category":{"_id":"58458b4fba4f1c0f009692bb","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-12-05T15:44:15.650Z","from_sync":false,"order":6,"slug":"datasets-hub","title":"DATASETS HUB"},"githubsync":"","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":45,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-05T18:00:51.201Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[]},"method":"post","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":42,"body":"If you want to filter all samples that are connected to a TCGA case with case ID '0004D251-3F70-4395-B175-C94C2F5B1B81,' you can use the following query:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /datasets/tcga/v0/query HTTP/1.1\\nHost: cgc-datasets-api.sbgenomics.com\\nX-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\",\n      \"language\": \"http\",\n      \"name\": \"Find samples connected to a case\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"entity\\\": \\\"samples\\\",\\n    \\\"hasCase\\\": \\\"0004D251-3F70-4395-B175-C94C2F5B1B81\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Request body\"\n    }\n  ]\n}\n[/block]\nThis request returns the response below. Note that it contains two `sample` objects: one for each sample matching the query above.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"count\\\": 2,\\n  \\\"_embedded\\\": {\\n    \\\"samples\\\": [\\n      {\\n        \\\"id\\\": \\\"9259E9EE-7279-4B62-8512-509CB705029C\\\",\\n        \\\"label\\\": \\\"9259E9EE-7279-4B62-8512-509CB705029C\\\",\\n        \\\"_links\\\": {\\n          \\\"self\\\": {\\n            \\\"href\\\": \\\"cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9259E9EE-7279-4B62-8512-509CB705029C\\\"\\n          }\\n        }\\n      },\\n      {\\n        \\\"id\\\": \\\"9EA47C2E-47A7-443D-99F0-F9B50A4729A6\\\",\\n        \\\"label\\\": \\\"9EA47C2E-47A7-443D-99F0-F9B50A4729A6\\\",\\n        \\\"_links\\\": {\\n          \\\"self\\\": {\\n            \\\"href\\\": \\\"cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6\\\"\\n          }\\n        }\\n      }\\n    ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response body\"\n    }\n  ]\n}\n[/block]\nFor each sample returned, the response lists:\n  * Its `href`: this is a path that can be used to obtain full information about the sample. The response returned when issuing a `GET` request to this path is reproduced below.\n  * Its TCGA `id`\n  * Its TCGA `label` \n\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##Secondary request\nIssuing a `GET` request to the href path will return the following data:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"_links\\\": {\\n    \\\"hasCase\\\": {\\n      \\\"href\\\": \\\"https://cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6/cases\\\"\\n    },\\n    \\\"hasFile\\\": {\\n      \\\"href\\\": \\\"https://cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6/files\\\"\\n    },\\n    \\\"hasPortion\\\": {\\n      \\\"href\\\": \\\"https://cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6/portions\\\"\\n    },\\n    \\\"self\\\": {\\n      \\\"href\\\": \\\"https://cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6\\\"\\n    }\\n  },\\n  \\\"hasTissueSourceSite\\\": \\\"Mayo Clinic - Rochester\\\",\\n  \\\"hasID\\\": \\\"TCGA-DD-AAVP-10A\\\",\\n  \\\"hasDaysToCollection\\\": 2467,\\n  \\\"hasOctEmbedded\\\": \\\"false\\\",\\n  \\\"id\\\": \\\"9EA47C2E-47A7-443D-99F0-F9B50A4729A6\\\",\\n  \\\"hasSampleType\\\": \\\"Blood Derived Normal\\\",\\n  \\\"label\\\": \\\"9EA47C2E-47A7-443D-99F0-F9B50A4729A6\\\",\\n  \\\"hasIsFFPE\\\": \\\"NO\\\",\\n  \\\"hasCountryOfSampleProcurement\\\": \\\"Korea South\\\",\\n  \\\"hasTissueSourceSiteCode\\\": \\\"DD\\\",\\n  \\\"hasSampleTypeCode\\\": \\\"10\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"<a href=\"query-datasets\" style=\"color:#132c56\">QUERY DATASETS</a> > <a href=\"about-the-datasets-api\" style=\"color:#132c56\">About the Datasets API</a> > <a href=\"query-via-the-datasets-api\" style=\"color:#132c56\">Query via the Datasets API</a> > Example query 1: Find samples...","slug":"example-query-1-find-samples-connected-to-a-case","type":"endpoint","title":"Example query 1: Find samples connected to a case"}

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

postExample query 1: Find samples connected to a case

<a href="query-datasets" style="color:#132c56">QUERY DATASETS</a> > <a href="about-the-datasets-api" style="color:#132c56">About the Datasets API</a> > <a href="query-via-the-datasets-api" style="color:#132c56">Query via the Datasets API</a> > Example query 1: Find samples...
If you want to filter all samples that are connected to a TCGA case with case ID '0004D251-3F70-4395-B175-C94C2F5B1B81,' you can use the following query: [block:code] { "codes": [ { "code": "POST /datasets/tcga/v0/query HTTP/1.1\nHost: cgc-datasets-api.sbgenomics.com\nX-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96", "language": "http", "name": "Find samples connected to a case" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"entity\": \"samples\",\n \"hasCase\": \"0004D251-3F70-4395-B175-C94C2F5B1B81\"\n}", "language": "json", "name": "Request body" } ] } [/block] This request returns the response below. Note that it contains two `sample` objects: one for each sample matching the query above. [block:code] { "codes": [ { "code": "{\n \"count\": 2,\n \"_embedded\": {\n \"samples\": [\n {\n \"id\": \"9259E9EE-7279-4B62-8512-509CB705029C\",\n \"label\": \"9259E9EE-7279-4B62-8512-509CB705029C\",\n \"_links\": {\n \"self\": {\n \"href\": \"cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9259E9EE-7279-4B62-8512-509CB705029C\"\n }\n }\n },\n {\n \"id\": \"9EA47C2E-47A7-443D-99F0-F9B50A4729A6\",\n \"label\": \"9EA47C2E-47A7-443D-99F0-F9B50A4729A6\",\n \"_links\": {\n \"self\": {\n \"href\": \"cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6\"\n }\n }\n }\n ]\n }\n}", "language": "json", "name": "Response body" } ] } [/block] For each sample returned, the response lists: * Its `href`: this is a path that can be used to obtain full information about the sample. The response returned when issuing a `GET` request to this path is reproduced below. * Its TCGA `id` * Its TCGA `label` <div align="right"><a href="#top">top</a></div> ##Secondary request Issuing a `GET` request to the href path will return the following data: [block:code] { "codes": [ { "code": "{\n \"_links\": {\n \"hasCase\": {\n \"href\": \"https://cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6/cases\"\n },\n \"hasFile\": {\n \"href\": \"https://cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6/files\"\n },\n \"hasPortion\": {\n \"href\": \"https://cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6/portions\"\n },\n \"self\": {\n \"href\": \"https://cgc-datasets-api.sbgenomics.com/datasets/tcga/v0/samples/9EA47C2E-47A7-443D-99F0-F9B50A4729A6\"\n }\n },\n \"hasTissueSourceSite\": \"Mayo Clinic - Rochester\",\n \"hasID\": \"TCGA-DD-AAVP-10A\",\n \"hasDaysToCollection\": 2467,\n \"hasOctEmbedded\": \"false\",\n \"id\": \"9EA47C2E-47A7-443D-99F0-F9B50A4729A6\",\n \"hasSampleType\": \"Blood Derived Normal\",\n \"label\": \"9EA47C2E-47A7-443D-99F0-F9B50A4729A6\",\n \"hasIsFFPE\": \"NO\",\n \"hasCountryOfSampleProcurement\": \"Korea South\",\n \"hasTissueSourceSiteCode\": \"DD\",\n \"hasSampleTypeCode\": \"10\"\n}", "language": "json" } ] } [/block]