https://github.com/mskcc/external-samples-rest
Rest service to retrieve DMP samples for IGO
https://github.com/mskcc/external-samples-rest
Last synced: 4 months ago
JSON representation
Rest service to retrieve DMP samples for IGO
- Host: GitHub
- URL: https://github.com/mskcc/external-samples-rest
- Owner: mskcc
- Created: 2017-12-29T16:19:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-08T19:10:12.000Z (over 6 years ago)
- Last Synced: 2025-02-28T08:28:55.680Z (over 1 year ago)
- Size: 97.7 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# external-samples-rest
Rest service to retrieve DMP samples for IGO
1. Samples endpoint
usage: /samples/
eg. for DMP Samples: /samples/P-0020725-N01
2. Get all samples for a patient:
a) by Cmo patient id
/samples/patientCmo/
b) by Dmp patient id
/samples/patientDmp/
3. Get samples using pagination
a) usage: samples/get?page=&size=
page number is 0 based
result: content + information about pages:
{
"last": {
"type": "boolean"
},
"totalPages":{
"type": "integer"
},
"totalElements":{
"type": "integer"
},
"size":{
"type": "integer"
},
"number":{
"type": "integer"
},
"sort":{
"type": "string"
},
"first":{
"type": "boolean"
},
"numberOfElements":{
"type": "integer"
}
}
b) sorting by any returned field: samples/get?page=1&size5&sort=runId&direction=desc
4. Returned fields:
{
“externalId”: {
“type” : “string”
},
“filePath”: {
“type” : “string”
},
“externalPatientId”: {
“type” : “string”
},
“tumorNormal”: {
“type” : “string”
},
“counter”: {
“type” : “integer”
},
“runId”: {
“type” : “string”
},
“sampleOrigin”: {
“type” : “string”
},
“sampleClass”: {
“type” : “string”
},
“cmoId”: {
“type” : “string”
},
“nucleidAcid”: {
“type” : “string”
},
“patientCmoId”: {
“type” : “string”
},
“specimenType”: {
“type” : “string”
},
“sex”: {
“type” : “string”
},
“oncotreeCode”: {
“type” : “string”
},
“baitVersion”: {
“type” : “string”
},
“tissueSite”: {
“type” : “string”
},
“preservationType”: {
“type” : “string”
},
“externalRunId”: {
“type” : “string”
}
}