Planned Experiment Db Resource¶
Resource URL
http://mytorrentserver/rundb/api/v1/plannedexperimentdb/
Schema URL
http://mytorrentserver/rundb/api/v1/plannedexperimentdb/schema/
Resource Fields¶
field | help text | default | nullable | readonly | blank | unique | type |
---|---|---|---|---|---|---|---|
origin | Unicode string data. Ex: “Hello World” | true | false | false | false | string | |
isReverseRun | Boolean data. Ex: True | false | false | false | true | false | boolean |
planDisplayedName | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
storage_options | Unicode string data. Ex: “Hello World” | A | false | false | false | false | string |
preAnalysis | Boolean data. Ex: True | true | false | false | true | false | boolean |
planShortID | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
username | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
planStatus | Unicode string data. Ex: “Hello World” | false | false | true | false | string | |
runMode | Unicode string data. Ex: “Hello World” | false | false | true | false | string | |
templatingKitBarcode | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
sampleTubeLabel | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
planExecutedDate | A date & time as a string. Ex: “2010-11-10T03:07:43” | n/a | true | false | false | false | datetime |
samplePrepKitName | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
reverse_primer | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
applicationGroup | A single related resource. Can be either a URI or set of nested resource data. | n/a | true | false | true | false | related |
seqKitBarcode | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
id | Integer data. Ex: 2673 | false | false | true | true | integer | |
metaData | Unicode string data. Ex: “Hello World” | {} | false | false | true | false | string |
sampleSets | Many related resources. Can be either a list of URIs or list of individually nested resource data. | n/a | true | false | true | false | related |
isFavorite | Boolean data. Ex: True | false | false | false | true | false | boolean |
qcValues | Many related resources. Can be either a list of URIs or list of individually nested resource data. | n/a | true | false | true | false | related |
samplePrepProtocol | Unicode string data. Ex: “Hello World” | true | false | false | false | string | |
isPlanGroup | Boolean data. Ex: True | false | false | false | true | false | boolean |
experiment | A single related resource. Can be either a URI or set of nested resource data. | n/a | true | false | true | false | related |
projects | Many related resources. Can be either a list of URIs or list of individually nested resource data. | n/a | true | false | true | false | related |
runType | Unicode string data. Ex: “Hello World” | GENS | false | false | false | false | string |
templatingKitName | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
planPGM | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
isSystemDefault | Boolean data. Ex: True | false | false | false | true | false | boolean |
autoName | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
isReusable | Boolean data. Ex: True | false | false | false | true | false | boolean |
controlSequencekitname | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
date | A date & time as a string. Ex: “2010-11-10T03:07:43” | n/a | true | false | false | false | datetime |
isSystem | Boolean data. Ex: True | false | false | false | true | false | boolean |
libkit | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
categories | Unicode string data. Ex: “Hello World” | true | false | false | false | string | |
planName | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
templatingSize | Unicode string data. Ex: “Hello World” | true | false | false | false | string | |
parentPlan | Unicode string data. Ex: “Hello World” | None | false | false | true | false | string |
childPlans | A list of data. Ex: [‘abc’, 26.73, 8] | [] | false | false | false | false | list |
pairedEndLibraryAdapterName | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
sampleGrouping | A single related resource. Can be either a URI or set of nested resource data. | n/a | true | false | true | false | related |
adapter | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
irworkflow | Unicode string data. Ex: “Hello World” | false | false | true | false | string | |
planExecuted | Boolean data. Ex: True | false | false | false | true | false | boolean |
project | Unicode string data. Ex: “Hello World” | n/a | false | true | true | false | string |
usePostBeadfind | Boolean data. Ex: True | true | false | false | true | false | boolean |
storageHost | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
expName | Unicode string data. Ex: “Hello World” | false | false | true | false | string | |
libraryReadLength | Integer data. Ex: 2673 | 0 | false | false | false | false | integer |
runname | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
usePreBeadfind | Boolean data. Ex: True | true | false | false | true | false | boolean |
planGUID | Unicode string data. Ex: “Hello World” | n/a | true | false | false | false | string |
cycles | Integer data. Ex: 2673 | n/a | true | false | false | false | integer |
resource_uri | Unicode string data. Ex: “Hello World” | n/a | false | true | false | false | string |
Example Response¶
{
"meta": {
"previous": null,
"total_count": 88,
"offset": 0,
"limit": 1,
"next": "/rundb/api/v1/plannedexperimentdb/?offset=1&limit=1&format=json"
},
"objects": [
{
"origin": "api|5.6.0.RC4",
"isReverseRun": false,
"planDisplayedName": "Chef - 220a9897 - 2017.08.28",
"storage_options": "A",
"preAnalysis": true,
"planShortID": "X8W9R",
"username": null,
"planStatus": "reserved",
"runMode": "",
"templatingKitBarcode": null,
"sampleTubeLabel": null,
"planExecutedDate": null,
"samplePrepKitName": null,
"reverse_primer": null,
"applicationGroup": null,
"seqKitBarcode": null,
"id": 103,
"metaData": {},
"sampleSets": [],
"isFavorite": false,
"qcValues": [],
"samplePrepProtocol": "",
"isPlanGroup": false,
"experiment": "/rundb/api/v1/experiment/95/",
"projects": [],
"runType": "GENS",
"templatingKitName": "Ion Chef S540 V1",
"planPGM": null,
"isSystemDefault": false,
"autoName": null,
"isReusable": false,
"controlSequencekitname": null,
"date": "2017-08-28T20:58:58.000662+00:00",
"isSystem": false,
"libkit": null,
"categories": "",
"planName": "Chef_-_220a9897_-_2017.08.28",
"templatingSize": "",
"parentPlan": null,
"childPlans": [],
"pairedEndLibraryAdapterName": null,
"sampleGrouping": null,
"adapter": null,
"irworkflow": "",
"planExecuted": false,
"project": "",
"usePostBeadfind": false,
"storageHost": null,
"expName": "",
"libraryReadLength": 0,
"runname": null,
"usePreBeadfind": true,
"planGUID": "f651801b-394d-4083-a6d7-ee342d27a9f1",
"cycles": null,
"resource_uri": "/rundb/api/v1/plannedexperimentdb/103/"
}
]
}
Allowed HTTP methods¶
- get
- post
- put
- delete
- patch